Auto-GPT 插件模板

用于开发您自己的 Auto-GPT 外部插件的起点

插件开发者须知

• 如果您希望您的插件直接位于代码库中，请改用 plugins 仓库 进行分叉。请阅读该仓库中的说明。
• 如需更全面和最新的指南，请参阅 plugins 仓库。
• 如果您使用此仓库开发自己的插件，请 编辑本 README 文件。

如何使用插件

1. 将插件仓库 克隆到 Auto-GPT 的 plugins 文件夹中。

2. 安装插件的依赖项（如有）： 在终端中导航至插件文件夹，运行以下命令以安装所需的依赖项：

      pip install -r requirements.txt
   

3. 更新 plugins_config.yaml 文件以启用插件。如果跳过此步骤，插件将不会被加载。

   plugin_folder:
      - config: {} # 根据插件的 README 和安装说明提供的配置。
      - enabled: true
   

Auto-GPT-Plugin-Template 快速上手指南

本指南旨在帮助开发者快速基于模板创建并启用 Auto-GPT 的外部插件。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：Windows、macOS 或 Linux
• Python 版本：建议 Python 3.8 或更高版本
• 前置依赖：
  • 已安装并配置好 Auto-GPT 主程序。
  • 已安装 pip 包管理工具。
  • 网络提示：若下载依赖较慢，建议使用国内镜像源（如清华源、阿里源）加速安装过程。

安装步骤

1. 克隆插件仓库

将插件模板仓库克隆到 Auto-GPT 主目录下的 plugins 文件夹中。请在终端执行以下命令（假设当前位于 Auto-GPT 根目录）：

git clone <你的插件仓库地址> ./plugins/<你的插件名称>

2. 安装依赖

进入插件目录并安装所需的 Python 依赖包。

标准安装命令：

cd ./plugins/<你的插件名称>
pip install -r requirements.txt

推荐使用国内镜像源加速安装：

pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple

3. 启用插件

修改 Auto-GPT 根目录下的 plugins_config.yaml 文件，以加载新插件。若跳过此步，插件将无法被识别。

请在配置文件中添加或更新以下内容：

plugin_folder:
   - config: {} # 此处填入插件 README 中指定的具体配置项
   - enabled: true

基本使用

完成上述安装与配置后，插件即已集成至 Auto-GPT 环境中。

1. 启动 Auto-GPT：在 Auto-GPT 根目录运行主程序启动命令。
2. 验证加载：观察启动日志，确认插件名称出现在已加载插件列表中。
3. 功能调用：根据您开发的插件具体功能，通过自然语言指令让 Auto-GPT 调用该插件能力。

注意：本模板仅为开发起点。正式开发时，请务必编辑插件目录下的 README.md 以说明具体的配置参数（替换上述 config: {} 中的内容）和功能用法。更多详细开发规范请参考 Auto-GPT-Plugins 官方仓库。