You may use the button above to open this repo in a Codespace
-For more info, check out
-the [GitHub documentation](https://docs.github.com/en/free-pro-team@latest/github/developing-online-with-codespaces/creating-a-codespace#creating-a-codespace).
-
+For more info, check out the [GitHub documentation](https://docs.github.com/en/free-pro-team@latest/github/developing-online-with-codespaces/creating-a-codespace#creating-a-codespace).
+
## VS Code Dev Containers
-
-Note: If you click this link you will open the main repo and not your local cloned repo, you can use this link and
-replace with your username and cloned repo name:
+Note: If you click this link you will open the main repo and not your local cloned repo, you can use this link and replace with your username and cloned repo name:
https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/geekan/MetaGPT
-If you already have VS Code and Docker installed, you can use the button above to get started. This will cause VS Code
-to automatically install the Dev Containers extension if needed, clone the source code into a container volume, and spin
-up a dev container for use.
+
+If you already have VS Code and Docker installed, you can use the button above to get started. This will cause VS Code to automatically install the Dev Containers extension if needed, clone the source code into a container volume, and spin up a dev container for use.
You can also follow these steps to open this repo in a container using the VS Code Dev Containers extension:
-1. If this is your first time using a development container, please ensure your system meets the pre-reqs (i.e. have
- Docker installed) in the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started).
+1. If this is your first time using a development container, please ensure your system meets the pre-reqs (i.e. have Docker installed) in the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started).
2. Open a locally cloned copy of the code:
- - Fork and Clone this repository to your local filesystem.
- - Press F1 and select the **Dev Containers: Open Folder in Container...** command.
- - Select the cloned copy of this folder, wait for the container to start, and try things out!
+ - Fork and Clone this repository to your local filesystem.
+ - Press F1 and select the **Dev Containers: Open Folder in Container...** command.
+ - Select the cloned copy of this folder, wait for the container to start, and try things out!
You can learn more in the [Dev Containers documentation](https://code.visualstudio.com/docs/devcontainers/containers).
## Tips and tricks
-* If you are working with the same repository folder in a container and Windows, you'll want consistent line endings (
- otherwise you may see hundreds of changes in the SCM view). The `.gitattributes` file in the root of this repo will
- disable line ending conversion and should prevent this.
- See [tips and tricks](https://code.visualstudio.com/docs/devcontainers/tips-and-tricks#_resolving-git-line-ending-issues-in-containers-resulting-in-many-modified-files)
- for more info.
-* If you'd like to review the contents of the image used in this dev container, you can check it out in
- the [devcontainers/images](https://github.com/devcontainers/images/tree/main/src/python) repo.
+* If you are working with the same repository folder in a container and Windows, you'll want consistent line endings (otherwise you may see hundreds of changes in the SCM view). The `.gitattributes` file in the root of this repo will disable line ending conversion and should prevent this. See [tips and tricks](https://code.visualstudio.com/docs/devcontainers/tips-and-tricks#_resolving-git-line-ending-issues-in-containers-resulting-in-many-modified-files) for more info.
+* If you'd like to review the contents of the image used in this dev container, you can check it out in the [devcontainers/images](https://github.com/devcontainers/images/tree/main/src/python) repo.
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
index 6ad3b598d..a774d0ed1 100644
--- a/.devcontainer/devcontainer.json
+++ b/.devcontainer/devcontainer.json
@@ -1,25 +1,27 @@
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/templates/tree/main/src/python
{
- "name": "Python 3",
- // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
- "image": "mcr.microsoft.com/devcontainers/python:0-3.11",
- // Features to add to the dev container. More info: https://containers.dev/features.
- // "features": {},
+ "name": "Python 3",
+ // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+ "image": "mcr.microsoft.com/devcontainers/python:0-3.11",
- // Configure tool-specific properties.
- "customizations": {
- // Configure properties specific to VS Code.
- "vscode": {
- "settings": {},
- "extensions": [
- "streetsidesoftware.code-spell-checker"
- ]
- }
- },
- // Use 'postCreateCommand' to run commands after the container is created.
- "postCreateCommand": "./.devcontainer/postCreateCommand.sh"
+ // Features to add to the dev container. More info: https://containers.dev/features.
+ // "features": {},
- // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
- // "remoteUser": "root"
+ // Configure tool-specific properties.
+ "customizations": {
+ // Configure properties specific to VS Code.
+ "vscode": {
+ "settings": {},
+ "extensions": [
+ "streetsidesoftware.code-spell-checker"
+ ]
+ }
+ },
+
+ // Use 'postCreateCommand' to run commands after the container is created.
+ "postCreateCommand": "./.devcontainer/postCreateCommand.sh"
+
+ // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+ // "remoteUser": "root"
}
diff --git a/.devcontainer/docker-compose.yaml b/.devcontainer/docker-compose.yaml
index 2f0116bf8..a9988b1f3 100644
--- a/.devcontainer/docker-compose.yaml
+++ b/.devcontainer/docker-compose.yaml
@@ -5,10 +5,10 @@ services:
dockerfile: Dockerfile
context: ..
volumes:
- # Update this to wherever you want VS Code to mount the folder of your project
+ # Update this to wherever you want VS Code to mount the folder of your project
- ..:/workspaces:cached
networks:
- - metagpt-network
+ - metagpt-network
# environment:
# MONGO_ROOT_USERNAME: root
# MONGO_ROOT_PASSWORD: example123
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index db11ddbb5..b1892a709 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -8,11 +8,11 @@ repos:
rev: 5.11.5
hooks:
- id: isort
- args: [ '--profile', 'black' ]
+ args: ['--profile', 'black']
exclude: >-
- (?x)^(
- .*__init__\.py$
- )
+ (?x)^(
+ .*__init__\.py$
+ )
- repo: https://github.com/astral-sh/ruff-pre-commit
# Ruff version.
@@ -24,4 +24,4 @@ repos:
rev: 23.3.0
hooks:
- id: black
- args: [ '--line-length', '120' ]
\ No newline at end of file
+ args: ['--line-length', '120']
\ No newline at end of file
diff --git a/README.md b/README.md
index f6dd33791..4bc480a01 100644
--- a/README.md
+++ b/README.md
@@ -25,11 +25,9 @@ # MetaGPT: The Multi-Agent Framework
-1. MetaGPT takes a **one line requirement** as input and outputs **user stories / competitive analysis / requirements /
- data structures / APIs / documents, etc.**
-2. Internally, MetaGPT includes **product managers / architects / project managers / engineers.** It provides the entire
- process of a **software company along with carefully orchestrated SOPs.**
- 1. `Code = SOP(Team)` is the core philosophy. We materialize SOP and apply it to teams composed of LLMs.
+1. MetaGPT takes a **one line requirement** as input and outputs **user stories / competitive analysis / requirements / data structures / APIs / documents, etc.**
+2. Internally, MetaGPT includes **product managers / architects / project managers / engineers.** It provides the entire process of a **software company along with carefully orchestrated SOPs.**
+ 1. `Code = SOP(Team)` is the core philosophy. We materialize SOP and apply it to teams composed of LLMs.
@@ -37,17 +35,21 @@ # MetaGPT: The Multi-Agent Framework
## MetaGPT's Abilities
+
https://github.com/geekan/MetaGPT/assets/34952977/34345016-5d13-489d-b9f9-b82ace413419
+
+
## Examples (fully generated by GPT-4)
-For example, if you type `python startup.py "Design a RecSys like Toutiao"`, you would get many outputs, one of them is
-data & api design
+For example, if you type `python startup.py "Design a RecSys like Toutiao"`, you would get many outputs, one of them is data & api design
-It costs approximately **$0.2** (in GPT-4 API fees) to generate one example with analysis and design, and around **$2.0
-** for a full project.
+It costs approximately **$0.2** (in GPT-4 API fees) to generate one example with analysis and design, and around **$2.0** for a full project.
+
+
+
## Installation
@@ -73,12 +75,10 @@ # Step 3: Clone the repository to your local machine, and install it.
**Note:**
-- If already have Chrome, Chromium, or MS Edge installed, you can skip downloading Chromium by setting the environment
- variable
+- If already have Chrome, Chromium, or MS Edge installed, you can skip downloading Chromium by setting the environment variable
`PUPPETEER_SKIP_CHROMIUM_DOWNLOAD` to `true`.
-- Some people are [having issues](https://github.com/mermaidjs/mermaid.cli/issues/15) installing this tool globally.
- Installing it locally is an alternative solution,
+- Some people are [having issues](https://github.com/mermaidjs/mermaid.cli/issues/15) installing this tool globally. Installing it locally is an alternative solution,
```bash
npm install @mermaid-js/mermaid-cli
@@ -91,75 +91,72 @@ # Step 3: Clone the repository to your local machine, and install it.
MMDC: "./node_modules/.bin/mmdc"
```
-- if `pip install -e.` fails with
- error `[Errno 13] Permission denied: '/usr/local/lib/python3.11/dist-packages/test-easy-install-13129.write-test'`,
- try instead running `pip install -e. --user`
+- if `pip install -e.` fails with error `[Errno 13] Permission denied: '/usr/local/lib/python3.11/dist-packages/test-easy-install-13129.write-test'`, try instead running `pip install -e. --user`
-- To convert Mermaid charts to SVG, PNG, and PDF formats. In addition to the Node.js version of Mermaid-CLI, you now
- have the option to use Python version Playwright, pyppeteer or mermaid.ink for this task.
+- To convert Mermaid charts to SVG, PNG, and PDF formats. In addition to the Node.js version of Mermaid-CLI, you now have the option to use Python version Playwright, pyppeteer or mermaid.ink for this task.
- - Playwright
- - **Install Playwright**
+ - Playwright
+ - **Install Playwright**
- ```bash
- pip install playwright
- ```
+ ```bash
+ pip install playwright
+ ```
- - **Install the Required Browsers**
+ - **Install the Required Browsers**
- to support PDF conversion, please install Chrominum.
+ to support PDF conversion, please install Chrominum.
- ```bash
- playwright install --with-deps chromium
- ```
+ ```bash
+ playwright install --with-deps chromium
+ ```
- - **modify `config.yaml`**
+ - **modify `config.yaml`**
- uncomment MERMAID_ENGINE from config.yaml and change it to `playwright`
+ uncomment MERMAID_ENGINE from config.yaml and change it to `playwright`
- ```yaml
- MERMAID_ENGINE: playwright
- ```
+ ```yaml
+ MERMAID_ENGINE: playwright
+ ```
- - pyppeteer
- - **Install pyppeteer**
+ - pyppeteer
+ - **Install pyppeteer**
- ```bash
- pip install pyppeteer
- ```
+ ```bash
+ pip install pyppeteer
+ ```
- - **Use your own Browsers**
+ - **Use your own Browsers**
- pyppeteer alow you use installed browsers, please set the following envirment
+ pyppeteer alow you use installed browsers, please set the following envirment
+
+ ```bash
+ export PUPPETEER_EXECUTABLE_PATH = /path/to/your/chromium or edge or chrome
+ ```
- ```bash
- export PUPPETEER_EXECUTABLE_PATH = /path/to/your/chromium or edge or chrome
- ```
+ please do not use this command to install browser, it is too old
- please do not use this command to install browser, it is too old
+ ```bash
+ pyppeteer-install
+ ```
- ```bash
- pyppeteer-install
- ```
+ - **modify `config.yaml`**
- - **modify `config.yaml`**
+ uncomment MERMAID_ENGINE from config.yaml and change it to `pyppeteer`
- uncomment MERMAID_ENGINE from config.yaml and change it to `pyppeteer`
+ ```yaml
+ MERMAID_ENGINE: pyppeteer
+ ```
- ```yaml
- MERMAID_ENGINE: pyppeteer
- ```
+ - mermaid.ink
+ - **modify `config.yaml`**
- - mermaid.ink
- - **modify `config.yaml`**
+ uncomment MERMAID_ENGINE from config.yaml and change it to `ink`
- uncomment MERMAID_ENGINE from config.yaml and change it to `ink`
+ ```yaml
+ MERMAID_ENGINE: ink
+ ```
- ```yaml
- MERMAID_ENGINE: ink
- ```
-
- Note: this method does not support pdf export.
+ Note: this method does not support pdf export.
### Installation by Docker
@@ -215,7 +212,7 @@ # Copy the configuration file and make the necessary modifications.
```
| Variable Name | config/key.yaml | env |
-|--------------------------------------------|-------------------------------------------|-------------------------------------------------|
+| ------------------------------------------ | ----------------------------------------- | ----------------------------------------------- |
| OPENAI_API_KEY # Replace with your own key | OPENAI_API_KEY: "sk-..." | export OPENAI_API_KEY="sk-..." |
| OPENAI_API_BASE # Optional | OPENAI_API_BASE: "https://