diff --git a/README.md b/README.md index e80082a3a..2ce768212 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ + # MetaGPT: The Multi-Agent Framework
@@ -50,9 +51,9 @@ # Step 2: Clone the repository to your local machine for latest version, and ins
cd MetaGPT
pip3 install -e. # or pip3 install metagpt # for stable version
-# Step 3: run the startup.py
+# Step 3: run metagpt cli
# setup your OPENAI_API_KEY in key.yaml copy from config.yaml
-python3 startup.py "Write a cli snake game"
+metagpt "Write a cli snake game"
# Step 4 [Optional]: If you want to save the artifacts like diagrams such as quadrant chart, system designs, sequence flow in the workspace, you can execute the step before Step 3. By default, the framework is compatible, and the entire process can be run completely without executing this step.
# If executing, ensure that NPM is installed on your system. Then install mermaid-js. (If you don't have npm in your computer, please go to the Node.js official website to install Node.js https://nodejs.org/ and then you will have npm tool in your computer.)
@@ -78,7 +79,7 @@ # Step 2: Run metagpt demo with container
-v /opt/metagpt/config/key.yaml:/app/metagpt/config/key.yaml \
-v /opt/metagpt/workspace:/app/metagpt/workspace \
metagpt/metagpt:latest \
- python startup.py "Write a cli snake game"
+ metagpt "Write a cli snake game"
```
detail installation please refer to [docker_install](https://docs.deepwisdom.ai/guide/get_started/installation.html#install-with-docker)
diff --git a/docs/FAQ-EN.md b/docs/FAQ-EN.md
index f9df50caf..b87e5da1e 100644
--- a/docs/FAQ-EN.md
+++ b/docs/FAQ-EN.md
@@ -98,7 +98,7 @@
1. How to change the investment amount?
- 1. You can view all commands by typing `python startup.py --help`
+ 1. You can view all commands by typing `metagpt --help`
1. Which version of Python is more stable?
diff --git a/docs/README_CN.md b/docs/README_CN.md
index 038925184..1e0edc533 100644
--- a/docs/README_CN.md
+++ b/docs/README_CN.md
@@ -47,9 +47,9 @@ # 第 2 步:克隆最新仓库到您的本地机器,并进行安装。
cd MetaGPT
pip3 install -e. # 或者 pip3 install metagpt # 安装稳定版本
-# 第 3 步:执行startup.py
+# 第 3 步:执行metagpt
# 拷贝config.yaml为key.yaml,并设置你自己的OPENAI_API_KEY
-python3 startup.py "Write a cli snake game"
+metagpt "Write a cli snake game"
# 第 4 步【可选的】:如果你想在执行过程中保存像象限图、系统设计、序列流程等图表这些产物,可以在第3步前执行该步骤。默认的,框架做了兼容,在不执行该步的情况下,也可以完整跑完整个流程。
# 如果执行,确保您的系统上安装了 NPM。并使用npm安装mermaid-js
@@ -75,7 +75,7 @@ # 步骤2: 使用容器运行metagpt演示
-v /opt/metagpt/config/key.yaml:/app/metagpt/config/key.yaml \
-v /opt/metagpt/workspace:/app/metagpt/workspace \
metagpt/metagpt:latest \
- python startup.py "Write a cli snake game"
+ metagpt "Write a cli snake game"
```
详细的安装请安装 [docker_install](https://docs.deepwisdom.ai/zhcn/guide/get_started/installation.html#%E4%BD%BF%E7%94%A8docker%E5%AE%89%E8%A3%85)
diff --git a/docs/README_JA.md b/docs/README_JA.md
index 411d190b4..210044ec2 100644
--- a/docs/README_JA.md
+++ b/docs/README_JA.md
@@ -41,7 +41,7 @@ ## MetaGPT の能力
## 例(GPT-4 で完全生成)
-例えば、`python startup.py "Toutiao のような RecSys をデザインする"`と入力すると、多くの出力が得られます
+例えば、`metagpt "Toutiao のような RecSys をデザインする"`と入力すると、多くの出力が得られます

@@ -67,9 +67,9 @@ # ステップ 2: リポジトリをローカルマシンにクローンし、
cd MetaGPT
pip install -e.
-# ステップ 3: startup.py を実行する
+# ステップ 3: metagpt を実行する
# config.yaml を key.yaml にコピーし、独自の OPENAI_API_KEY を設定します
-python3 startup.py "Write a cli snake game"
+metagpt "Write a cli snake game"
# ステップ 4 [オプション]: 実行中に PRD ファイルなどのアーティファクトを保存する場合は、ステップ 3 の前にこのステップを実行できます。デフォルトでは、フレームワークには互換性があり、この手順を実行しなくてもプロセス全体を完了できます。
# NPM がシステムにインストールされていることを確認してください。次に mermaid-js をインストールします。(お使いのコンピューターに npm がない場合は、Node.js 公式サイトで Node.js https://nodejs.org/ をインストールしてください。)
@@ -178,7 +178,7 @@ # ステップ 2: コンテナで metagpt デモを実行する
-v /opt/metagpt/config/key.yaml:/app/metagpt/config/key.yaml \
-v /opt/metagpt/workspace:/app/metagpt/workspace \
metagpt/metagpt:latest \
- python startup.py "Write a cli snake game"
+ metagpt "Write a cli snake game"
# コンテナを起動し、その中でコマンドを実行することもできます
docker run --name metagpt -d \
@@ -188,7 +188,7 @@ # コンテナを起動し、その中でコマンドを実行することもで
metagpt/metagpt:latest
docker exec -it metagpt /bin/bash
-$ python startup.py "Write a cli snake game"
+$ metagpt "Write a cli snake game"
```
コマンド `docker run ...` は以下のことを行います:
@@ -196,7 +196,7 @@ # コンテナを起動し、その中でコマンドを実行することもで
- 特権モードで実行し、ブラウザの実行権限を得る
- ホスト設定ファイル `/opt/metagpt/config/key.yaml` をコンテナ `/app/metagpt/config/key.yaml` にマップします
- ホストディレクトリ `/opt/metagpt/workspace` をコンテナディレクトリ `/app/metagpt/workspace` にマップするs
-- デモコマンド `python startup.py "Write a cli snake game"` を実行する
+- デモコマンド `metagpt "Write a cli snake game"` を実行する
### 自分でイメージをビルドする
@@ -225,11 +225,11 @@ ## チュートリアル: スタートアップの開始
```shell
# スクリプトの実行
-python startup.py "Write a cli snake game"
+metagpt "Write a cli snake game"
# プロジェクトの実施にエンジニアを雇わないこと
-python startup.py "Write a cli snake game" --implement False
+metagpt "Write a cli snake game" --implement False
# エンジニアを雇い、コードレビューを行う
-python startup.py "Write a cli snake game" --code_review True
+metagpt "Write a cli snake game" --code_review True
```
スクリプトを実行すると、`workspace/` ディレクトリに新しいプロジェクトが見つかります。
@@ -239,17 +239,17 @@ ### プラットフォームまたはツールの設定
要件を述べるときに、どのプラットフォームまたはツールを使用するかを指定できます。
```shell
-python startup.py "pygame をベースとした cli ヘビゲームを書く"
+metagpt "pygame をベースとした cli ヘビゲームを書く"
```
### 使用方法
```
会社名
- startup.py - 私たちは AI で構成されたソフトウェア・スタートアップです。私たちに投資することは、無限の可能性に満ちた未来に力を与えることです。
+ metagpt - 私たちは AI で構成されたソフトウェア・スタートアップです。私たちに投資することは、無限の可能性に満ちた未来に力を与えることです。
シノプシス
- startup.py IDEA