diff --git a/README.md b/README.md index b0faf85c7..3668c2ab2 100644 --- a/README.md +++ b/README.md @@ -92,6 +92,16 @@ ### QuickStart & Demo Video https://github.com/geekan/MetaGPT/assets/34952977/34345016-5d13-489d-b9f9-b82ace413419 +### Incremental Requirement & Fix Bug +By using the following parameters, it is possible to iterate continuously on the project generated by MetaGPT. + +| CLI Parameter Name | Value Type | Optional/Required | Description | Usage | +|--------------------|------------| --------- |------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| `--project-path` | path | Optional | The path where to load the project file from the previous version. | metagpt "BUG_FEEDBACK_XXX" --project-path "YOUR_PROJECT_FULL_PATH"

metagpt "INCREMENT_REQUIREMENTS" --project-path "YOUR_PROJECT_FULL_PATH" | +| `--reqa-file` | File name | Optional | The name of the file for which to regenerate unit tests. This is a relative path based on the source code folder.
`--reqa-file "main.py"` | metagpt --reqa-file "main.py | +| `--project-name` | str | Optional | Specify the name of new project to be used. The project name must adhere to both folder and code variable naming conventions. | metagpt "NEW_REQUIREMENTS" --project-name "YOUR_PROJECT_NAME" | + + ## Tutorial - 🗒 [Online Document](https://docs.deepwisdom.ai/)