gpt_engineer.applications.cli.main.main

gpt_engineer.applications.cli.main.main(project_path: str = <typer.models.ArgumentInfo object>, model: str = <typer.models.OptionInfo object>, temperature: float = <typer.models.OptionInfo object>, improve_mode: bool = <typer.models.OptionInfo object>, lite_mode: bool = <typer.models.OptionInfo object>, clarify_mode: bool = <typer.models.OptionInfo object>, self_heal_mode: bool = <typer.models.OptionInfo object>, azure_endpoint: str = <typer.models.OptionInfo object>, use_custom_preprompts: bool = <typer.models.OptionInfo object>, llm_via_clipboard: bool = <typer.models.OptionInfo object>, verbose: bool = <typer.models.OptionInfo object>, debug: bool = <typer.models.OptionInfo object>, prompt_file: str = <typer.models.OptionInfo object>, entrypoint_prompt_file: str = <typer.models.OptionInfo object>, image_directory: str = <typer.models.OptionInfo object>, use_cache: bool = <typer.models.OptionInfo object>, skip_file_selection: bool = <typer.models.OptionInfo object>, no_execution: bool = <typer.models.OptionInfo object>, sysinfo: bool = <typer.models.OptionInfo object>, diff_timeout: int = <typer.models.OptionInfo object>)[source]

The main entry point for the CLI tool that generates or improves a project.

This function sets up the CLI tool, loads environment variables, initializes the AI, and processes the user’s request to generate or improve a project based on the provided arguments.

Parameters:

  • project_path (str) – The file path to the project directory.

  • model (str) – The model ID string for the AI.

  • temperature (float) – The temperature setting for the AI’s responses.

  • improve_mode (bool) – Flag indicating whether to improve an existing project.

  • lite_mode (bool) – Flag indicating whether to run in lite mode.

  • clarify_mode (bool) – Flag indicating whether to discuss specifications with AI before implementation.

  • self_heal_mode (bool) – Flag indicating whether to enable self-healing mode.

  • azure_endpoint (str) – The endpoint for Azure OpenAI services.

  • use_custom_preprompts (bool) – Flag indicating whether to use custom preprompts.

  • prompt_file (str) – Relative path to a text file containing a prompt.

  • entrypoint_prompt_file (str) – Relative path to a text file containing a file that specifies requirements for you entrypoint.

  • image_directory (str) – Relative path to a folder containing images.

  • use_cache (bool) – Speeds up computations and saves tokens when running the same prompt multiple times by caching the LLM response.

  • verbose (bool) – Flag indicating whether to enable verbose logging.

  • skip_file_selection (bool) – Skip interactive file selection in improve mode and use the generated TOML file directly

  • no_execution (bool) – Run setup but to not call LLM or write any code. For testing purposes.

  • sysinfo (bool) – Flag indicating whether to output system information for debugging.

Return type:

None