AutoGPT Agent 用户指南¶

注意

本指南假设您位于 autogpts/autogpt 文件夹中，该文件夹包含 AutoGPT Agent。

命令行界面¶

运行 ./autogpt.sh（或其任何子命令）并使用 --help 参数，可以列出所有可能的子命令和参数：

$ ./autogpt.sh --help
Usage: python -m autogpt [OPTIONS] COMMAND [ARGS]...

Options:
  --help  显示此帮助消息并退出。

Commands:
  run    根据指定的任务设置并运行代理。
  serve  启动符合 Agent Protocol 的 AutoGPT 服务器，创建...

对于 Windows 用户

在 Windows 上，使用 .\autogpt.bat 替代 ./autogpt.sh。其他内容（子命令、参数）应该保持不变。

使用 Docker

对于使用 Docker 的情况，请将示例中的脚本替换为 docker compose run --rm auto-gpt：

docker compose run --rm auto-gpt --ai-settings <filename>
docker compose run --rm auto-gpt serve

`run` – 命令行界面模式¶

run 子命令以传统的命令行界面启动 AutoGPT。

./autogpt.sh run --help

$ ./autogpt.sh run --help
用法: python -m autogpt run [OPTIONS]

  根据用户指定的任务设置并运行一个代理，或者恢复一个现有的代理。

选项:
  -c, --continuous                启用连续模式
  -y, --skip-reprompt             跳过脚本开始时的重新提示消息
  -C, --ai-settings FILE          指定要使用的 ai_settings.yaml 文件，相对于 AutoGPT 根目录。还将自动跳过重新提示。
  -P, --prompt-settings FILE      指定要使用的 prompt_settings.yaml 文件。
  -l, --continuous-limit INTEGER  定义连续模式下运行的次数
  --speak                         启用朗读模式
  --debug                         启用调试模式
  --gpt3only                      仅启用 GPT3.5 模式
  --gpt4only                      仅启用 GPT4 模式
  -b, --browser-name TEXT         指定使用 selenium 爬取网页时要使用的 web 浏览器。
  --allow-downloads               危险操作：允许 AutoGPT 原生下载文件。
  --skip-news                     指定是否在启动时抑制最新新闻的输出。
  --install-plugin-deps           安装第三方插件的外部依赖。
  --ai-name TEXT                  AI 名称覆盖
  --ai-role TEXT                  AI 角色覆盖
  --constraint TEXT               添加或覆盖要包含在提示中的 AI 约束；可以多次使用以传递多个约束条件
  --resource TEXT                 添加或覆盖要包含在提示中的 AI 资源；可以多次使用以传递多个资源
  --best-practice TEXT            添加或覆盖要包含在提示中的 AI 最佳实践；可以多次使用以传递多个最佳实践
  --override-directives           如果指定，则 --constraint、--resource 和 --best-practice 将覆盖 AI 的指令，而不是附加到它们上面
  --help                          显示此帮助消息并退出。

这种模式允许运行单个代理，并在终止时保存代理的状态。这意味着您可以在以后的时间恢复代理。另请参阅[代理状态]。

注意

出于历史原因，当没有指定子命令时，CLI 将默认为 run 子命令：运行 ./autogpt.sh run [OPTIONS] 与运行 ./autogpt.sh [OPTIONS] 相同，但这可能会在将来发生变化。

💀 连续模式 ⚠️¶

在没有用户授权的情况下运行 AI，完全自动化。不推荐使用连续模式。它有潜在的危险，可能导致您的 AI 永远运行下去，或者执行您通常不会授权的操作。请自行承担风险。

./autogpt.sh --continuous

要退出程序，请按Ctrl+C

`serve` – 使用UI的Agent Protocol模式¶

使用serve命令，应用程序会暴露一个符合Agent Protocol标准的API，并提供一个前端界面，默认在http://localhost:8000上提供服务。您可以使用AP_SERVER_PORT环境变量来配置服务的端口。

./autogpt.sh serve --help

$ ./autogpt.sh serve --help
Usage: python -m autogpt serve [OPTIONS]

  启动一个符合Agent Protocol标准的AutoGPT服务器，为每个任务创建一个自定义代理。

Options:
  -P, --prompt-settings FILE  指定要使用的prompt_settings.yaml文件。
  --debug                     启用调试模式
  --gpt3only                  启用仅GPT3.5模式
  --gpt4only                  启用仅GPT4模式
  -b, --browser-name TEXT     使用selenium爬取网页时指定要使用的web浏览器。
  --allow-downloads           危险操作：允许AutoGPT原生下载文件。
  --install-plugin-deps       安装第三方插件的外部依赖。
  --help                      显示此帮助信息并退出。

有关应用程序的API更多信息，请参阅agentprotocol.ai。

参数¶

Attention

大多数参数与配置选项等效。请参阅.env.template以获取所有可用的配置选项。

Note

将尖括号（<>）中的内容替换为您想要指定的值。

以下是在运行AutoGPT时可以使用的一些常见参数：

使用不同的AI设置文件运行AutoGPT
```
./autogpt.sh --ai-settings <文件名>
```

使用不同的提示设置文件运行AutoGPT

./autogpt.sh --prompt-settings <文件名>

Note

对于其中一些标志，有一些简写形式，例如-P代表--prompt-settings。使用./autogpt.sh --help获取更多信息。

代理状态¶

个体代理的状态存储在data/agents文件夹中。您可以以各种方式使用它：

以后恢复您的代理。
为您的代理创建“检查点”，以便您始终可以返回到特定的历史点。
共享您的代理！

工作空间¶

代理可以读取和写入文件。这发生在workspace文件夹中，该文件夹位于data/agents/<agent_id>/中。除此文件夹之外的文件无法被代理访问，除非将RESTRICT_TO_WORKSPACE设置为False。

警告

我们不建议禁用RESTRICT_TO_WORKSPACE，除非AutoGPT在无法造成任何损害的沙盒环境中运行（例如Docker或虚拟机）。

日志¶

活动、错误和调试日志位于logs中。

提示

您是否注意到您的代理有奇怪的行为？您是否有一个有趣的用例？您是否有一个要报告的错误？按照下面的步骤启用您的日志。您可以在提交问题报告或与我们讨论问题时包含这些日志。

要打印调试日志：

./autogpt.sh --debug

禁用命令分类¶

如果您想选择性地禁用某些命令组，可以在您的 .env 文件中使用 DISABLED_COMMAND_CATEGORIES 配置。您可以在这里找到可用的分类列表。

例如，要禁用与编码相关的功能，请将其设置为以下值：

DISABLED_COMMAND_CATEGORIES=autogpt.commands.execute_code