Here is the GitHub Link:

More details coming soon!

In order to install this application you need to have some basic knowledge of how to use the Terminal, how to set up a Conda environment.

If you run into any issues with the installation, here are a few resources that will help you:

Starting With Terminal

What is Anaconda for Python

What is GitHub?

Guide to Installing and Running the ChatDev GitHub Application

Table of Contents

  1. Introduction
  2. Prerequisites
  3. Step-by-Step Installation
    1. Clone the GitHub Repository
    2. Set Up Python Environment
    3. Install Dependencies
    4. Set OpenAI API Key
    5. Build Your Software
  4. Running the Software
  5. Conclusion


This guide aims to walk you through the process of installing and running the ChatDev application, available on GitHub. By following the steps outlined below, you will be able to get the application up and running on your local machine.


  • Python 3.9 or higher
  • Anaconda (optional, but recommended for managing environments)
  • Git installed on your machine
  • OpenAI API key

Step-by-Step Installation

Clone the GitHub Repository

  1. Open a terminal window.
  2. Run the following command to clone the ChatDev repository:
git clone

Set Up Python Environment

  1. Make sure you have Python 3.9 or higher installed. If you’re using Anaconda, you can create and activate a new environment using the following commands:
conda create -n ChatDev_conda_env python=3.9 -y
conda activate ChatDev_conda_env

Replace ChatDev_conda_env with your preferred environment name, if desired.

Install Dependencies

  1. Navigate into the ChatDev directory:
cd ChatDev
  1. Install the required dependencies:
pip3 install -r requirements.txt

Set OpenAI API Key

  1. Export your OpenAI API key as an environment variable. Replace "your_OpenAI_API_key" with your actual API key. This is session-specific and will need to be set again if you open a new terminal session.
    • On Unix/Linux:
    export OPENAI_API_KEY="your_OpenAI_API_key"
    • On Windows:

Build Your Software

  1. Run the following command to initiate the building of your software. Replace [description_of_your_idea] with your idea’s description and [project_name] with your desired project name.
    • On Unix/Linux:
    python3 --task "[description_of_your_idea]" --name "[project_name]"
    • On Windows:
    python --task "[description_of_your_idea]" --name "[project_name]"

Running the Software

  1. Once generated, navigate to the WareHouse directory and then to your specific project folder (e.g., project_name_DefaultOrganization_timestamp). cd WareHouse/project_name_DefaultOrganization_timestamp
  2. Run the software:
    • On Unix/Linux:
    • On Windows:


You have successfully installed and run the ChatDev application. Feel free to explore its features and adapt it to suit your needs.

Disclaimer: This guide is intended for informational purposes and may not cover all possible configurations or scenarios. Always refer to the official documentation for the most accurate and detailed information.