Devon 开源项目安装与使用指南

1. 项目目录结构及介绍

Devon 项目的目录结构如下：

Devon/
├── autopr/
├── devon-tui/
├── devon_agent/
├── devon_swe_bench_experimental/
├── electron/
├── eval/
├── devon_config/
├── gitignore
├── CONTRIBUTING.md
├── LICENSE
├── MANIFESTO.md
├── README.md
├── build.sh
├── build_ui.sh
├── contributor.md
├── install.sh
├── package-lock.json
├── poetry.lock
├── pyinstaller.sh
├── pyproject.toml
└── ...

目录结构介绍

• autopr/: 自动PR相关文件。
• devon-tui/: 终端用户界面相关文件。
• devon_agent/: 后端代理相关文件。
• devon_swe_bench_experimental/: 实验性软件工程基准相关文件。
• electron/: Electron 应用相关文件。
• eval/: 评估相关文件。
• devon_config/: 配置文件相关文件。
• gitignore: Git 忽略文件配置。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证。
• MANIFESTO.md: 项目宣言。
• README.md: 项目介绍和使用说明。
• build.sh: 构建脚本。
• build_ui.sh: UI 构建脚本。
• contributor.md: 贡献者指南。
• install.sh: 安装脚本。
• package-lock.json: npm 包锁定文件。
• poetry.lock: Poetry 包锁定文件。
• pyinstaller.sh: PyInstaller 打包脚本。
• pyproject.toml: Poetry 项目配置文件。

2. 项目启动文件介绍

后端启动

后端使用 pipx 安装并启动：

pipx install devon_agent

主 UI 启动

主 UI 使用 npm 安装并启动：

npx devon-ui

终端 UI 启动

终端 UI 使用 npm 安装并启动：

npm install -g devon-tui
devon-tui

3. 项目配置文件介绍

配置文件位置

配置文件主要位于 devon_config/ 目录下。

主要配置文件

• pyproject.toml: Poetry 项目配置文件，包含项目依赖和构建配置。
• package-lock.json: npm 包锁定文件，确保依赖版本一致性。
• devon_config/: 包含项目的具体配置文件，如 API 密钥配置等。

环境变量配置

在使用终端 UI 时，需要设置 API 密钥环境变量：

export ANTHROPIC_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
# 或
export OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
# 或
export GROQ_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

通过以上步骤，您可以顺利安装并启动 Devon 项目，并了解其目录结构和配置文件的使用方法。