1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
# AutoGPT Agent User Guide
!!! note
This guide assumes you are in the `autogpts/autogpt` folder, where the AutoGPT Agent
is located.
## Command Line Interface
Running `./autogpt.sh` (or any of its subcommands) with `--help` lists all the possible
sub-commands and arguments you can use:
```shell
$ ./autogpt.sh --help
Usage: python -m autogpt [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
run Sets up and runs an agent, based on the task specified by the...
serve Starts an Agent Protocol compliant AutoGPT server, which creates...
```
!!! important "For Windows users"
On Windows, use `.\autogpt.bat` instead of `./autogpt.sh`.
Everything else (subcommands, arguments) should work the same.
!!! info "Usage with Docker"
For use with Docker, replace the script in the examples with
`docker compose run --rm auto-gpt`:
```shell
docker compose run --rm auto-gpt --ai-settings <filename>
docker compose run --rm auto-gpt serve
```
### `run` – CLI mode
The `run` sub-command starts AutoGPT with the legacy CLI interface.
<details>
<summary>
<code>./autogpt.sh run --help</code>
</summary>
```shell
$ ./autogpt.sh run --help
Usage: python -m autogpt run [OPTIONS]
Sets up and runs an agent, based on the task specified by the user, or
resumes an existing agent.
Options:
-c, --continuous Enable Continuous Mode
-y, --skip-reprompt Skips the re-prompting messages at the
beginning of the script
-C, --ai-settings FILE Specifies which ai_settings.yaml file to
use, relative to the AutoGPT root directory.
Will also automatically skip the re-prompt.
-P, --prompt-settings FILE Specifies which prompt_settings.yaml file to
use.
-l, --continuous-limit INTEGER Defines the number of times to run in
continuous mode
--speak Enable Speak Mode
--debug Enable Debug Mode
--gpt3only Enable GPT3.5 Only Mode
--gpt4only Enable GPT4 Only Mode
-b, --browser-name TEXT Specifies which web-browser to use when
using selenium to scrape the web.
--allow-downloads Dangerous: Allows AutoGPT to download files
natively.
--skip-news Specifies whether to suppress the output of
latest news on startup.
--install-plugin-deps Installs external dependencies for 3rd party
plugins.
--ai-name TEXT AI name override
--ai-role TEXT AI role override
--constraint TEXT Add or override AI constraints to include in
the prompt; may be used multiple times to
pass multiple constraints
--resource TEXT Add or override AI resources to include in
the prompt; may be used multiple times to
pass multiple resources
--best-practice TEXT Add or override AI best practices to include
in the prompt; may be used multiple times to
pass multiple best practices
--override-directives If specified, --constraint, --resource and
--best-practice will override the AI's
directives instead of being appended to them
--help Show this message and exit.
```
</details>
This mode allows running a single agent, and saves the agent's state when terminated.
This means you can *resume* agents at a later time. See also [agent state].
!!! note
For legacy reasons, the CLI will default to the `run` subcommand when none is
specified: running `./autogpt.sh run [OPTIONS]` does the same as `./autogpt.sh [OPTIONS]`,
but this may change in the future.
#### 💀 Continuous Mode ⚠️
Run the AI **without** user authorization, 100% automated.
Continuous mode is NOT recommended.
It is potentially dangerous and may cause your AI to run forever or carry out actions you would not usually authorize.
Use at your own risk.
```shell
./autogpt.sh --continuous
```
To exit the program, press ++ctrl+c++
### `serve` – Agent Protocol mode with UI
With `serve`, the application exposes an Agent Protocol compliant API and serves a
frontend, by default on `http://localhost:8000`. You can configure the port it is served on with the `AP_SERVER_PORT` environment variable.
<details>
<summary>
<code>./autogpt.sh serve --help</code>
</summary>
```shell
$ ./autogpt.sh serve --help
Usage: python -m autogpt serve [OPTIONS]
Starts an Agent Protocol compliant AutoGPT server, which creates a custom
agent for every task.
Options:
-P, --prompt-settings FILE Specifies which prompt_settings.yaml file to
use.
--debug Enable Debug Mode
--gpt3only Enable GPT3.5 Only Mode
--gpt4only Enable GPT4 Only Mode
-b, --browser-name TEXT Specifies which web-browser to use when using
selenium to scrape the web.
--allow-downloads Dangerous: Allows AutoGPT to download files
natively.
--install-plugin-deps Installs external dependencies for 3rd party
plugins.
--help Show this message and exit.
```
</details>
For more information about the API of the application, see [agentprotocol.ai](https://agentprotocol.ai).
<!-- TODO: add guide/manual for frontend -->
### Arguments
!!! attention
Most arguments are equivalent to configuration options. See [`.env.template`][.env.template]
for all available configuration options.
!!! note
Replace anything in angled brackets (<>) to a value you want to specify
Here are some common arguments you can use when running AutoGPT:
* Run AutoGPT with a different AI Settings file
```shell
./autogpt.sh --ai-settings <filename>
```
* Run AutoGPT with a different Prompt Settings file
```shell
./autogpt.sh --prompt-settings <filename>
```
!!! note
There are shorthands for some of these flags, for example `-P` for `--prompt-settings`.
Use `./autogpt.sh --help` for more information.
[.env.template]: https://github.com/Significant-Gravitas/AutoGPT/tree/master/autogpts/autogpt/.env.template
## Agent State
[agent state]: #agent-state
The state of individual agents is stored in the `data/agents` folder. You can use this
in various ways:
* Resume your agent at a later time.
* Create "checkpoints" for your agent so you can always go back to specific points in
its history.
* Share your agent!
## Workspace
[workspace]: #workspace
Agents can read and write files. This happens in the `workspace` folder, which
is in `data/agents/<agent_id>/`. Files outside of this folder can not be accessed by the
agent *unless* `RESTRICT_TO_WORKSPACE` is set to `False`.
!!! warning
We do not recommend disabling `RESTRICT_TO_WORKSPACE`, unless AutoGPT is running in
a sandbox environment where it couldn't do any damage (e.g. Docker or a VM).
## Logs
Activity, Error, and Debug logs are located in `logs`.
!!! tip
Do you notice weird behavior with your agent? Do you have an interesting use case? Do you have a bug you want to report?
Follow the step below to enable your logs. You can include these logs when making an issue report or discussing an issue with us.
To print out debug logs:
```shell
./autogpt.sh --debug
```
## Disabling Commands
The best way to disable commands is to disable or remove the [component][components] that provides them.
However, if you want to selectively disable some commands, you can use the `DISABLED_COMMANDS` config in your `.env`.
Put the names of the commands you want to disable, separated by commas.
You can find the list of commands in built-in components [here][commands].
For example, to disable python coding features, set it to the value below:
```ini
DISABLED_COMMANDS=execute_python_code,execute_python_file
```
[components]: ./components/components.md
[commands]: ./components/built-in-components.md
|
