🤖 Claude Engineer

Claude Engineer is an interactive command-line interface (CLI) that leverages the power of Anthropic's Claude-3.5-Sonnet model to assist with software development tasks. This tool combines the capabilities of a large language model with practical file system operations and web search functionality.

✨ Features

• 💬 Interactive chat interface with Claude-3.5-Sonnet
• 📁 File system operations (create folders, files, read/write files)
• 🔍 Web search capabilities using Tavily API
• 🌈 Syntax highlighting for code snippets
• 🏗️ Project structure creation and management
• 🧐 Code analysis and improvement suggestions
• 🖼️ Vision capabilities support via drag and drop of images in the terminal
• 🚀 Automode for autonomous task completion
• 🔄 Iteration tracking in automode

🛠️ Installation

1. Clone this repository:

   git clone https://github.com/Doriandarko/claude-engineer.git
   cd claude-engineer
   

2. Install the required dependencies:

   pip install -r requirements.txt
   

3. Set up your API keys:

   • Copy the .env.example file to create a new .env file:

     cp .env.example .env
     

   • Open the .env file and replace the placeholder values with your actual API keys:

     ANTHROPIC_API_KEY=your_actual_anthropic_api_key_here
     TAVILY_API_KEY=your_actual_tavily_api_key_here
     

   • The script will automatically load these environment variables using python-dotenv
   • Note: Never commit your actual .env file to version control

🚀 Usage

Running with Python

Run the main script to start the Claude Engineer interface:

python main.py

Running with Docker

1. Ensure you have Docker and Docker Compose installed on your system.

2. Run the following command:

   docker-compose run --rm claude-engineer
   

   This command runs the container in interactive mode and removes it after use.

3. To stop the container, type exit in the Claude Engineer interface or press Ctrl+C in the terminal.

Interacting with Claude Engineer

Once started, you can interact with Claude Engineer by typing your queries or commands. Some example interactions:

• "Create a new Python project structure for a web application"
• "Explain the code in file.py and suggest improvements"
• "Search for the latest best practices in React development"
• "Help me debug this error: [paste your error message]"

Special commands:

• Type 'exit' to end the conversation and close the application.
• Type 'image' to include an image in your message.
• Type 'automode' plus the max amount of iterations to enter Autonomous mode.
• Press Ctrl+C at any time to exit the automode to return to regular chat.

🤖 Automode

Automode allows Claude to work autonomously on complex tasks. When in automode:

1. Claude sets clear, achievable goals based on your request.
2. It works through these goals one by one, using available tools as needed.
3. Claude provides regular updates on its progress.
4. Automode continues until goals are completed or the maximum number of iterations is reached.

To use automode:

1. Type 'automode' when prompted for input.
2. Provide your request when prompted.
3. Claude will work autonomously, providing updates after each iteration.
4. Automode exits when the task is completed or after reaching the maximum number of iterations.

Note: Claude will only have access to the files in the root folders of the script or any folder path you provide it.

👥 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.