| ## MetaGPT Usage |
|
|
| ### Configuration |
|
|
| - Configure your `OPENAI_API_KEY` in any of `config/key.yaml / config/config.yaml / env` |
| - Priority order: `config/key.yaml > config/config.yaml > env` |
|
|
| ```bash |
| # Copy the configuration file and make the necessary modifications. |
| cp config/config.yaml config/key.yaml |
| ``` |
|
|
| | 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://<YOUR_SITE>/v1" | export OPENAI_API_BASE="https://<YOUR_SITE>/v1" | |
|
|
| ### Initiating a startup |
|
|
| ```shell |
| # Run the script |
| python startup.py "Write a cli snake game" |
| # Do not hire an engineer to implement the project |
| python startup.py "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 |
| ``` |
|
|
| After running the script, you can find your new project in the `workspace/` directory. |
|
|
| ### 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" |
| ``` |
|
|
| ### 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. |
| |
| SYNOPSIS |
| startup.py IDEA <flags> |
| |
| DESCRIPTION |
| We are a software startup comprised of AI. By investing in us, you are empowering a future filled with limitless possibilities. |
| |
| POSITIONAL ARGUMENTS |
| IDEA |
| Type: str |
| Your innovative idea, such as "Creating a snake game." |
| |
| FLAGS |
| --investment=INVESTMENT |
| Type: float |
| Default: 3.0 |
| As an investor, you have the opportunity to contribute a certain dollar amount to this AI company. |
| --n_round=N_ROUND |
| Type: int |
| Default: 5 |
| |
| NOTES |
| You can also use flags syntax for POSITIONAL ARGUMENTS |
| ``` |
