Skip to content
This repository has been archived by the owner on Jul 4, 2024. It is now read-only.

Update README.md #5

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
34 changes: 25 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,6 @@ This plugin adds a "clone_autogpt" command that starts a new AutoGPT process, op
- Removed from 0.2.0 - may return in a future release.

---
You need EXECUTE_LOCAL_COMMANDS=True

You can tell AutoGPT to clone itself, as part of its tasks:

**Example Goals:**
Expand Down Expand Up @@ -75,13 +73,31 @@ Invoke-WebRequest -Uri "https://github.com/KayLuke/Auto-GPT-Dolly-Plugin/archive

This plugin can be configured via the following .env variables:

- DOLLY_DEBUG (Default=False): Whether to launch the clones with --debug
- DOLLY_CONTINUOUS_LIMIT (Default=5): The maximum number of cycles per clone
- DOLLY_SEPARATE_MEMORY_INDEX (Default=False): Whether to create a separate MEMORY_INDEX env variable for each clone. The separate MEMORY_INDEXes are created by appending the clone's name to the main MEMORY_INDEX
- DOLLY_SEPARATE_SETTINGS (Default=False): Whether to create a separate settings file and pass it into each clone with --ai-settings commandline variable. The separate settings files will be created by appending the clone's name to the settings file or DOLLY_SETTINGS_TEMPLATE (see below)
- DOLLY_SETTINGS_TEMPLATE (Default=ai_settings_clone_template.yaml): If DOLLY_SEPARATE_SETTINGS is True, this file will be used to create settings files for each clone. It should be placed in the working directory. Within the file, <CLONE_NAME> will be replaced with the name that AutoGPT chooses for the clone, and <CLONE_GOALS> will be replaced with the tasks that AutoGPT wants the clone to perform.
- DOLLY_SEPARATE_INSTRUCTIONS (Default=False): If you're using the wonda prompting technique, this will cause AutoGPT to write the clone's goals to an instrunctions_<CLONE_NAME>.txt file.

```
EXECUTE_LOCAL_COMMANDS=True

################################################################################
### Dolly
################################################################################
##DOLLY_DEBUG (Default=False): Whether to launch the clones with --debug
##DOLLY_CONTINUOUS_LIMIT (Default=5): The maximum number of cycles per clone
##DOLLY_SEPARATE_MEMORY_INDEX (Default=False): Whether to create a separate MEMORY_INDEX env variable for each clone. The separate ##MEMORY_INDEXes are created by appending the clone's name to the main MEMORY_INDEX
##DOLLY_SEPARATE_SETTINGS (Default=False): Whether to create a separate settings file and pass it into each clone with --ai-settings commandline variable. The separate settings files will be created by appending the clone's name to the settings file or ##DOLLY_SETTINGS_TEMPLATE (see below)
##DOLLY_SETTINGS_TEMPLATE (Default=ai_settings_clone_template.yaml): If DOLLY_SEPARATE_SETTINGS is True, this file will be used to create settings files for each clone. It should be placed in the working directory. Within the file, <CLONE_NAME> will be replaced with the name that AutoGPT chooses for the clone, and <CLONE_GOALS> will be replaced with the tasks that AutoGPT wants the clone to perform.
##DOLLY_SEPARATE_INSTRUCTIONS (Default=False): If you're using the wonda prompting technique, this will cause AutoGPT to write the clone's goals to an instrunctions_<CLONE_NAME>.txt file.
#DOLLY_DEBUG=False
#DOLLY_CONTINOUS_LIMIT=Default
#DOLLY_SEPARATE_MEMORY_INDEX=False
#DOLLY_SEPARATE_SETTINGS=False
#DOLLY_SETTINGS_TEMPLATE=Default
#DOLLY_SEPARATE_INSTRUCTIONS=False

################################################################################
ALLOWLISTED PLUGINS
################################################################################

ALLOWLISTED_PLUGINS=AutoGPTDollyPlugin
```

## Feedback

Expand Down