AutoAgent 项目使用教程

AutoAgent 项目使用教程

AutoAgent "AutoAgent: Fully-Automated and Zero-Code LLM Agent Framework" 项目地址: https://gitcode.com/gh_mirrors/au/AutoAgent

1. 项目目录结构及介绍

AutoAgent 项目的目录结构如下：

AutoAgent/
├── assets/              # 存储项目相关资源
├── autoagent/           # 核心代码目录
├── docs/                # 文档目录
├── evaluation/          # 性能评估相关代码
├── loop_utils/          # 循环工具相关代码
├── .env.template        # 环境变量模板文件
├── .gitattributes       # Git 属性配置文件
├── .gitignore           # Git 忽略文件列表
├── LICENSE              # 项目许可证文件
├── README.md            # 项目说明文件
├── constant.py          # 常量定义文件
├── process_tool_docs.py # 工具文档处理脚本
├── pyproject.toml       # 项目配置文件
├── setup.cfg            # 设置配置文件
└── tool_docs.csv        # 工具文档数据文件

• assets/: 存储与项目相关的静态资源，如图片、样式表等。
• autoagent/: 包含了项目的核心代码，如类定义、函数实现等。
• docs/: 存储项目的文档资料。
• evaluation/: 包含了用于评估项目性能的代码。
• loop_utils/: 提供了一些循环处理相关的工具函数。
• .env.template: 提供了一个环境变量配置的模板。
• .gitattributes: 配置 Git 的一些属性。
• .gitignore: 定义了 Git 忽略的文件和目录。
• LICENSE: 项目使用的许可证信息。
• README.md: 项目的说明文档，介绍了项目的基本信息和如何使用。
• constant.py: 定义了一些项目中使用的常量。
• process_tool_docs.py: 一个处理工具文档的脚本。
• pyproject.toml: 项目使用的配置文件。
• setup.cfg: 设置项目的构建和打包配置。
• tool_docs.csv: 存储工具文档的数据文件。

2. 项目的启动文件介绍

项目的启动主要通过命令行进行。在项目目录中，可以使用以下命令启动不同的模式：

• auto main: 启动完整的功能，包括用户模式、代理编辑器和工作流编辑器。
• auto deep-research: 启动更轻量级的用户模式。

具体的启动命令和参数配置如下：

auto main
# 或者
auto deep-research --container_name <名称> --port <端口号>

3. 项目的配置文件介绍

项目使用 .env.template 文件作为环境变量的模板，用户需要根据自己的需求填写相应的 API 密钥和其他配置信息。配置文件的基本格式如下：

# 必需的 GitHub 令牌
GITHUB_AI_TOKEN=<你的GitHub令牌>

# 可选的 API 密钥
OPENAI_API_KEY=<你的OpenAI API密钥>
DEEPSEEK_API_KEY=<你的DeepSeek API密钥>
ANTHROPIC_API_KEY=<你的Anthropic API密钥>
GEMINI_API_KEY=<你的Gemini API密钥>
HUGGINGFACE_API_KEY=<你的HuggingFace API密钥>
GROQ_API_KEY=<你的Groq API密钥>
XAI_API_KEY=<你的XAI API密钥>

用户需要将 <你的GitHub令牌> 等占位符替换为实际的 API 密钥。在项目启动时，会读取这些环境变量以配置 API 调用。

AutoAgent "AutoAgent: Fully-Automated and Zero-Code LLM Agent Framework" 项目地址: https://gitcode.com/gh_mirrors/au/AutoAgent