Skip to content
Clean Coder Docs

Quick Start

Start your journey with Clean Coder with a few simple commands!

Installation

Clone repo:

git clone https://github.com/GregorD1A1/Clean-Coder-AI

Go to directory:

cd Clean-Coder-AI

Create virtual environment and activate:

Linux/Mac:

python3 -m venv venv
source venv/bin/activate

Windows:

python -m venv venv
venv\Scripts\activate

Install dependencies:

pip install -r requirements.txt

Run:

To run Clean Coder use:

python manager.py

Optionally, if you want to create a single feature inside your project instead of planning the whole project, run:

python single_task_coder.py

First-Time Setup

When running Single Task Coder for the first time, it will prompt you to input a few variables, which are saved in the .env file.

  1. API Keys: Provide at least one API key for Anthropic, OpenAI, or OpenRouter. Adding more keys ensures fallback options during LLM shortages.

  2. Directory Path: Enter the full path to the directory where you want to write or modify code.

  3. Todoist API Key: Provide your Todoist API key.

  4. Coding Rules (Optional): Optionally, provide coding rules for your project and describe what your project is about. Learn more here.

  5. Describe Your Vision: On the first run, Manager will prompt you to describe your project in detail. Include as much information as possible.

🔥 Tips for a Good Project Description:
  • Provide a clear vision for each future feature
  • Write how the application should look when ready
  • Specify if tests and docs should be included
You can update the project vision anytime by editing the `.clean_coder/project_plan.txt` file in your project directory.

The basic setup is done! Go ahead and learn how to use Manager or Single Task functionalities.

Happy coding! 😋