use metagpt cli instead. update all related docs

README.md

@@ -1,3 +1,4 @@
+
 # MetaGPT: The Multi-Agent Framework
 
 <p align="center">
@@ -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)

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?
 

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)

docs/README_JA.md

@@ -41,7 +41,7 @@ ## MetaGPT の能力
 
 ## 例（GPT-4 で完全生成）
 
-例えば、`python startup.py "Toutiao のような RecSys をデザインする"`と入力すると、多くの出力が得られます
+例えば、`metagpt "Toutiao のような RecSys をデザインする"`と入力すると、多くの出力が得られます
 
 ![Jinri Toutiao Recsys データと API デザイン](resources/workspace/content_rec_sys/resources/data_api_design.png)
 
@@ -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 <flags>
+    metagpt IDEA <flags>
 
 説明
     私たちは AI で構成されたソフトウェア・スタートアップです。私たちに投資することは、無限の可能性に満ちた未来に力を与えることです。

docs/install/docker_install.md

@@ -15,7 +15,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 \
-    python3 startup.py "Write a cli snake game"
+    metagpt "Write a cli snake game"
 
 # You can also start a container and execute commands in it
 docker run --name metagpt -d \
@@ -25,7 +25,7 @@ # You can also start a container and execute commands in it
     metagpt/metagpt:latest
 
 docker exec -it metagpt /bin/bash
-$ python3 startup.py "Write a cli snake game"
+$ metagpt "Write a cli snake game"
 ```
 
 The command `docker run ...` do the following things:
@@ -33,7 +33,7 @@ # You can also start a container and execute commands in it
 - Run in privileged mode to have permission to run the browser
 - Map host configure file `/opt/metagpt/config/key.yaml` to container `/app/metagpt/config/key.yaml`
 - Map host directory `/opt/metagpt/workspace` to container `/app/metagpt/workspace`
-- Execute the demo command `python3 startup.py "Write a cli snake game"`
+- Execute the demo command `metagpt "Write a cli snake game"`
 
 ### Build image by yourself
 

docs/install/docker_install_cn.md

@@ -15,7 +15,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 \
@@ -25,7 +25,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 ...`做了以下事情:
@@ -33,7 +33,7 @@ # 您也可以启动一个容器并在其中执行命令
 - 以特权模式运行，有权限运行浏览器
 - 将主机文件 `/opt/metagpt/config/key.yaml` 映射到容器文件 `/app/metagpt/config/key.yaml`
 - 将主机目录 `/opt/metagpt/workspace` 映射到容器目录 `/app/metagpt/workspace`
-- 执行示例命令 `python startup.py "Write a cli snake game"`
+- 执行示例命令 `metagpt "Write a cli snake game"`
 
 ### 自己构建镜像
 

docs/tutorial/usage.md

@@ -19,11 +19,11 @@ ### Initiating a startup
 
 ```shell
 # Run the script
-python startup.py "Write a cli snake game"
+metagpt "Write a cli snake game"
 # Do not hire an engineer to implement the project
-python startup.py "Write a cli snake game" --implement False
+metagpt "Write a cli snake game" --implement False
 # Hire an engineer and perform code reviews
-python startup.py "Write a cli snake game" --code_review True
+metagpt "Write a cli snake game" --code_review True
 ```
 
 After running the script, you can find your new project in the `workspace/` directory.
@@ -33,17 +33,17 @@ ### Preference of Platform or Tool
 You can tell which platform or tool you want to use when stating your requirements.
 
 ```shell
-python startup.py "Write a cli snake game based on pygame"
+metagpt "Write a cli snake game based on pygame"
 ```
 
 ### Usage
 
 ```
 NAME
-    startup.py - We are a software startup comprised of AI. By investing in us, you are empowering a future filled with limitless possibilities.
+    metagpt - We are a software startup comprised of AI. By investing in us, you are empowering a future filled with limitless possibilities.
 
 SYNOPSIS
-    startup.py IDEA <flags>
+    metagpt IDEA <flags>
 
 DESCRIPTION
     We are a software startup comprised of AI. By investing in us, you are empowering a future filled with limitless possibilities.

docs/tutorial/usage_cn.md

@@ -18,9 +18,9 @@ # 复制配置文件并进行必要的修改
 ### 示例：启动一个创业公司
 
 ```shell
-python startup.py "写一个命令行贪吃蛇"
+metagpt "写一个命令行贪吃蛇"
 # 开启code review模式会花费更多的金钱, 但是会提升代码质量和成功率
-python startup.py "写一个命令行贪吃蛇" --code_review True
+metagpt "写一个命令行贪吃蛇" --code_review True
 ```
 
 运行脚本后，您可以在 `workspace/` 目录中找到您的新项目。
@@ -29,17 +29,17 @@ ### 平台或工具的倾向性
 可以在阐述需求时说明想要使用的平台或工具。
 例如：
 ```shell
-python startup.py "写一个基于pygame的命令行贪吃蛇"
+metagpt "写一个基于pygame的命令行贪吃蛇"
 ```
 
 ### 使用
 
 ```
 名称
-    startup.py - 我们是一家AI软件创业公司。通过投资我们，您将赋能一个充满无限可能的未来。
+    metagpt - 我们是一家AI软件创业公司。通过投资我们，您将赋能一个充满无限可能的未来。
 
 概要
-    startup.py IDEA <flags>
+    metagpt IDEA <flags>
 
 描述
     我们是一家AI软件创业公司。通过投资我们，您将赋能一个充满无限可能的未来。

metagpt/actions/write_docstring.py

@@ -16,7 +16,7 @@ Options:
                                 Default: 'google'
 
 Example:
-    python3 -m metagpt.actions.write_docstring startup.py --overwrite False --style=numpy
+    python3 -m metagpt.actions.write_docstring ./metagpt/startup.py --overwrite False --style=numpy
 
 This script uses the 'fire' library to create a command-line interface. It generates docstrings for the given Python code using
 the specified docstring style and adds them to the code.

tests/metagpt/test_startup.py

@@ -16,6 +16,7 @@ runner = CliRunner()
 
 @pytest.mark.asyncio
 async def test_team():
+    # FIXME: we're now using "metagpt" cli, so the entrance should be replaced instead.
     company = Team()
     company.run_project("做一个基础搜索引擎，可以支持知识库")
     history = await company.run(n_round=5)