微信扫一扫article
README
🚀 代码管理工具
本代码管理工具具备强大的自动化功能，能为代码库生成全面文档、自动制定测试计划以及开展专业的代码审查，极大提升开发效率与代码质量。
🚀 快速开始
本工具为开发者提供了生成文档、自动生成测试计划和自动代码审查等核心功能，助力开发者高效完成开发工作。
✨ 主要特性
- 生成文档：为代码库生成全面的技术文档。
- 自动生成测试计划：为代码中的函数和组件生成详细的测试方案。
- 自动代码审查：提供资深开发人员级别的代码审查反馈。
📦 安装指南
安装步骤
请按照以下步骤进行安装：
- 克隆本仓库到本地机器。
- 使用npm或yarn进行依赖项安装。
- 配置环境变量，特别是
OPENROUTER_API_KEY。
环境变量
以下是需要设置的关键环境变量：
| 属性 | 详情 |
|------|------|
| OPENROUTER_API_KEY | 用于调用OpenRouter API的密钥 |
| OPENROUTER_MODEL | 可选，默认为"anthropic/claude-3-7-sonnet" |
| MAX_FILE_SIZE_KB | 可选，默认为512，表示每个目录的最大文件大小限制（KB） |
| MAX_FILES_PER_DIR | 可选，默认为20，表示每个目录的最大处理文件数量 |
💻 使用示例
生成文档
该工具可以生成全面的代码库技术文档：
{
"path": "/路径/到/你的/项目",
"openRouterApiKey": "你的-api-密钥", // 可选参数
"model": "anthropic/claude-3-7-sonnet", // 可选参数
"updateExisting": true // 可选，缺省为true
}
自动生成测试计划
该工具能够生成详细的测试方案：
{
"path": "/路径/到/你的/项目",
"openRouterApiKey": "你的-api-密钥", // 可选参数
"model": "anthropic/claude-3-7-sonnet", // 可选参数
"updateExisting": true // 可选，缺省为true
}
自动代码审查
该工具提供专业级的代码审查反馈：
{
"path": "/路径/到/你的/项目",
"openRouterApiKey": "你的-api-密钥", // 可选参数
"model": "anthropic/claude-3-7-sonnet", // 可选参数
"updateExisting": true // 可选，缺省为true
}
📚 详细文档
输出文件说明
文档输出
生成的主要文档类型包括：
documentation.md：包含代码库的全面技术文档，内容涵盖代码的目的和作用、关键函数和类的详细说明、文件之间的关系描述、整合子组件的信息。testplan.md：包含详细的测试方案，内容包括各函数适合的测试类型（单元测试、集成测试、端到端测试）、常见边界情况分析、依赖项 mocking 要求、集成测试策略建议。review.md：提供资深开发人员级别的审查反馈，内容涵盖安全隐患和潜在漏洞、编码规范中的违规点、可能存在的bug或架构问题、改进机会和重构建议、实用的改进建议（避免风格上的微调）。
备用文件
当目录超过大小或文件数量限制时，生成以下备用文件：
undocumented.md：用于文档生成过程中的未处理内容，包含忽略处理的原因说明、已分析但排除在外的文件列表、如何解决问题的指导（如增加限制或手动创建内容）。
问题排查
API密钥相关问题
若出现无效API密钥错误，请执行以下检查：
- 确保已设置
OPENROUTER_API_KEY环境变量。 - 验证OpenRouter账户处于活跃状态。
- 确认拥有足够的API调用额度。
大小限制问题
如果遇到因目录过大或文件数量过多导致的处理失败，请执行以下操作：
- 调整
MAX_FILE_SIZE_KB和MAX_FILES_PER_DIR环境变量以增加限制。 - 考虑对非常大的目录进行手动文档编写。
模型选择问题
如果对生成结果的质量不满意，可以尝试更换模型：
- 设置
OPENROUTER_MODEL环境变量为所需的其他模型名称。
📄 许可证
本项目采用CC0-1.0许可证，作品版权归属于公共领域，由美国能源部拥有。
🔧 技术细节
贡献指南
欢迎各位开发者积极参与项目贡献！请随意提交Pull Request。
添加新功能模块
为了方便添加新的自动化工具，请遵循以下步骤：
- 在
src/tools目录下创建新的工具类文件。 - 实现相应的业务逻辑和接口适配。
- 更新主程序以支持新功能的调用。