Welcome to the official documentation for cli_engineer, an agentic command-line tool for software engineering automation. This documentation provides a comprehensive guide to understanding, using, and contributing to the project.
- Quick Start: Get
cli_engineerup and running in minutes. - User Guide: Comprehensive guide to installation, configuration, and usage.
- Command Reference: A quick reference for all available commands and their options.
- Configuration: Detailed instructions on how to configure
cli_engineer.tomlto use different LLM providers and customize behavior.
- Architecture: An overview of the system's architecture, design principles, and how the components interact.
- The Agentic Loop: A deep dive into the plan-execute-review cycle that powers the agent.
- Core Components: Detailed explanation of the main modules like the Planner, Executor, and Reviewer.
- LLM Providers: Information on the supported Large Language Model providers (OpenAI, Anthropic, Gemini, Ollama) and how they are integrated.
- UI and Logging: Details on the dashboard UI, simple text mode, and file logging capabilities.
- Contributing Guide: Guidelines for developers who want to contribute to the cli_engineer project.
- Code of Conduct: Standards for behavior within the
cli_engineercommunity. - Documentation Structure: An overview of how the documentation is organized.