Autodocument

🚀 Autodoc 自动化文档工具

Autodoc 是一款自动化文档工具，能够为代码库自动生成文档、测试计划和代码审查反馈，帮助开发者提高工作效率，减少手动编写文档的工作量。

🚀 快速开始

📦 安装指南

请访问 发布页面 下载适合您操作系统的安装包。

配置环境变量

在首次运行前，请设置以下环境变量：

• OPENROUTER_API_KEY：从 OpenRouter 获取的有效 API 密钥。
• MAX_FILE_SIZE_KB（可选）：限制每个目录处理的最大文件大小，单位为 KB，默认值为 51200。
• MAX_FILES_PER_DIR（可选）：每个目录允许处理的最多文件数，默认值为 200。

💻 使用示例

安装完成后运行

node /path/to/autodoc/build/index.js

工具调用示例

基础用法

以下是使用 Autodoc 自动生成文档、测试计划和代码审查的基础示例：

自动生成文档

{
  "jsonrpc": "2.0",
  "method": "call_tool",
  "params": {
    "name": "generate_documentation",
    "arguments": {
      "path": "/path/to/project",
      "openRouterApiKey": "your-api-key-here"
    }
  },
  "id": 1
}

自动生成测试计划

{
  "jsonrpc": "2.0",
  "method": "call_tool",
  "params": {
    "name": "autotestplan",
    "arguments": {
      "path": "/path/to/project",
      "openRouterApiKey": "your-api-key-here"
    }
  },
  "id": 1
}

自动生成代码审查

{
  "jsonrpc": "2.0",
  "method": "call_tool",
  "params": {
    "name": "autoreview",
    "arguments": {
      "path": "/path/to/project",
      "openRouterApiKey": "your-api-key-here"
    }
  },
  "id": 1
}

✨ 主要特性

自动生成文档（generate_documentation）

为代码库生成全面的文档，输入参数如下：

• path：必填项，指定要处理的项目路径。
• openRouterApiKey：可选，提供 OpenRouter API 密钥，默认从环境变量读取。
• model：可选，默认使用 "anthropic/claude-3-7-sonnet" 模型。
• updateExisting：可选，默认为 true，表示覆盖现有文档文件。

自动生成测试计划（autotestplan）

为代码库生成详细的测试计划，输入参数如下：

• path：必填项，指定要处理的项目路径。
• openRouterApiKey：可选，提供 OpenRouter API 密钥，默认从环境变量读取。
• model：可选，默认使用 "anthropic/claude-3-7-sonnet" 模型。
• updateExisting：可选，默认为 true，表示覆盖现有测试计划文件。

自动生成代码审查（autoreview）

生成高级别开发者对代码库的审查反馈，输入参数如下：

• path：必填项，指定要处理的项目路径。
• openRouterApiKey：可选，提供 OpenRouter API 密钥，默认从环境变量读取。
• model：可选，默认使用 "anthropic/claude-3-7-sonnet" 模型。
• updateExisting：可选，默认为 true，表示覆盖现有审查反馈文件。

📚 详细文档

输出文件说明

工具执行后会在指定目录生成以下文件：

• 文档文件：
  • documentation.md：包含项目的核心功能、设计思路和使用说明。
  • api_reference.md：记录所有接口及其详细信息。
• 测试计划文件：
  • test_plan.md：列出所有需要执行的测试用例及优先级。
  • test_steps.md：详细描述每个测试步骤和预期结果。
• 审查反馈文件：
  • review_report.md：记录代码审查过程中发现的所有问题和改进建议。

常见问题处理

错误码说明

• ERROR_API_KEY_INVALID：API 密钥无效或已过期。
• ERROR_PATH_NOT_FOUND：指定的路径不存在或不可访问。
• ERROR_FILE_SIZE_EXCEEDED：文件大小超出限制。
• ERROR_MAX_FILES_REACHED：处理的文件数量达到上限。

错误日志查看

工具运行时会在控制台输出实时日志，并在完成或中断后生成 autodoc.log 文件，记录所有操作和错误信息。

🔧 技术细节

项目贡献

欢迎参与开源社区建设！请访问 GitHub 仓库 提交问题、功能请求或代码贡献。

⚠️ 重要提示

使用本工具前，请确保已仔细阅读并理解相关文档和技术规范，以获得最佳的使用体验。