Autodocument

🚀 Autodoc - Automated Documentation Tool

Autodoc is an automated documentation tool that simplifies the process of generating documentation, test plans, and code reviews for your projects. It leverages OpenRouter's API to provide comprehensive and accurate outputs.

🚀 Quick Start

📦 Installation

Please visit the Release Page to download the installation package suitable for your operating system.

⚙️ Configuration

Before running the tool for the first time, please set the following environment variables:

• OPENROUTER_API_KEY: A valid API key obtained from OpenRouter.
• MAX_FILE_SIZE_KB (optional): Limits the maximum file size processed per directory, in KB. The default value is 51200.
• MAX_FILES_PER_DIR (optional): The maximum number of files allowed to be processed per directory. The default value is 200.

💻 Usage Examples

Run after installation

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

Tool invocation examples

Automatic documentation generation

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

Automatic test plan generation

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

Automatic code review generation

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

✨ Features

Automatic Documentation Generation (generate_documentation)

Generates comprehensive documentation for the codebase:

• Input parameters:
  • path: Required. Specifies the project path to be processed.
  • openRouterApiKey: Optional. Provides the OpenRouter API key. By default, it reads from the environment variable.
  • model: Optional. By default, it uses the "anthropic/claude-3-7-sonnet" model.
  • updateExisting: Optional. Defaults to true, indicating that existing documentation files will be overwritten.

Automatic Test Plan Generation (autotestplan)

Generates detailed test plans for the codebase:

• Input parameters:
  • path: Required. Specifies the project path to be processed.
  • openRouterApiKey: Optional. Provides the OpenRouter API key. By default, it reads from the environment variable.
  • model: Optional. By default, it uses the "anthropic/claude-3-7-sonnet" model.
  • updateExisting: Optional. Defaults to true, indicating that existing test plan files will be overwritten.

Automatic Code Review Generation (autoreview)

Generates high-level developer review feedback for the codebase:

• Input parameters:
  • path: Required. Specifies the project path to be processed.
  • openRouterApiKey: Optional. Provides the OpenRouter API key. By default, it reads from the environment variable.
  • model: Optional. By default, it uses the "anthropic/claude-3-7-sonnet" model.
  • updateExisting: Optional. Defaults to true, indicating that existing review feedback files will be overwritten.

📚 Documentation

Output Files

After the tool is executed, the following files will be generated in the specified directory:

• Documentation files:

  • documentation.md: Contains the project's core functions, design ideas, and usage instructions.
  • api_reference.md: Records all interfaces and their detailed information.

• Test plan files:

  • test_plan.md: Lists all test cases to be executed and their priorities.
  • test_steps.md: Describes each test step and expected results in detail.

• Review feedback files:

  • review_report.md: Records all issues and improvement suggestions found during the code review process.

Handling Common Issues

Error Code Explanation

• ERROR_API_KEY_INVALID: The API key is invalid or has expired.
• ERROR_PATH_NOT_FOUND: The specified path does not exist or is inaccessible.
• ERROR_FILE_SIZE_EXCEEDED: The file size exceeds the limit.
• ERROR_MAX_FILES_REACHED: The number of processed files has reached the upper limit.

Viewing Error Logs

The tool will output real-time logs on the console during runtime and generate an autodoc.log file after completion or interruption, recording all operations and error information.

🤝 Project Contribution

Welcome to contribute to the open-source community! Please visit the GitHub Repository to submit issues, feature requests, or code contributions.

⚠️ Important Note

Before using this tool, please ensure that you have carefully read and understood the relevant documentation and technical specifications to achieve the best user experience.