Autodocument

🚀 Management Tool for Code Repositories

This management tool is designed to streamline the development process by offering a suite of automated features. It can generate detailed technical documentation, create comprehensive test plans, and conduct in - depth code reviews for your codebase.

🚀 Quick Start

✨ Features

• Generate Documentation: Create comprehensive technical documentation for your codebase.
• Automatically Generate Test Plans: Develop detailed test scenarios for functions and components in your code.
• Automated Code Review: Provide code review feedback at the level of senior developers.

📦 Installation

Please follow these steps to install the tool:

1. Clone this repository to your local machine.
2. Install dependencies using npm or yarn.
3. Configure environment variables, especially OPENROUTER_API_KEY.

Environment Variables

The following are the key environment variables that need to be set:

• OPENROUTER_API_KEY: The key used to call the OpenRouter API.
• OPENROUTER_MODEL: Optional, default is "anthropic/claude - 3 - 7 - sonnet".
• MAX_FILE_SIZE_KB: Optional, default is 512, indicating the maximum file size limit (KB) for each directory.
• MAX_FILES_PER_DIR: Optional, default is 20, indicating the maximum number of files to be processed in each directory.

💻 Usage Examples

Generate Documentation

The tool can generate comprehensive technical documentation for your codebase:

{
  "path": "/path/to/your/project",
  "openRouterApiKey": "your-api-key", // Optional parameter
  "model": "anthropic/claude-3-7-sonnet", // Optional parameter
  "updateExisting": true // Optional, default is true
}

Automatically Generate Test Plans

The tool can generate detailed test scenarios:

{
  "path": "/path/to/your/project",
  "openRouterApiKey": "your-api-key", // Optional parameter
  "model": "anthropic/claude-3-7-sonnet", // Optional parameter
  "updateExisting": true // Optional, default is true
}

Automated Code Review

The tool provides professional - level code review feedback:

{
  "path": "/path/to/your/project",
  "openRouterApiKey": "your-api-key", // Optional parameter
  "model": "anthropic/claude-3-7-sonnet", // Optional parameter
  "updateExisting": true // Optional, default is true
}

📚 Documentation

Output Files

Main Output

• documentation.md: Contains comprehensive technical documentation of the codebase, covering:
  • The purpose and function of the code.
  • Detailed descriptions of key functions and classes.
  • Descriptions of relationships between files.
  • Information on integrating sub - components.
• testplan.md: Contains detailed test scenarios, including:
  • Suitable test types for each function (unit tests, integration tests, end - to - end tests).
  • Analysis of common boundary cases.
  • Requirements for dependency mocking.
  • Suggestions for integration test strategies.
• review.md: Provides review feedback at the level of senior developers, covering:
  • Security risks and potential vulnerabilities.
  • Violations of coding standards.
  • Possible bugs or architectural issues.
  • Opportunities for improvement and refactoring suggestions.
  • Practical improvement suggestions (avoiding minor style adjustments).

Backup Files

When the directory exceeds the size or file number limit, the following backup files are generated:

• undocumented.md: Used for unprocessed content during the documentation generation process, including:
  • Explanations of the reasons for ignoring processing.
  • A list of files that have been analyzed but excluded.
  • Guidance on how to solve the problem (such as increasing limits or manually creating content).

Troubleshooting

API Key Issues

If you encounter an invalid API key error, perform the following checks:

1. Ensure that the OPENROUTER_API_KEY environment variable is set.
2. Verify that your OpenRouter account is active.
3. Confirm that you have sufficient API call quotas.

Size Limit Issues

If you experience processing failures due to large directories or a large number of files, perform the following operations:

1. Adjust the MAX_FILE_SIZE_KB and MAX_FILES_PER_DIR environment variables to increase the limits.
2. Consider manually writing documentation for very large directories.

Model Selection Issues

If you are not satisfied with the quality of the generated results, you can try changing the model:

• Set the OPENROUTER_MODEL environment variable to the name of another desired model.

📄 License

This project is licensed under the CC0 - 1.0 license. The copyright of the work belongs to the public domain and is owned by the US Department of Energy.

Contribution Guide

We welcome all developers to actively contribute to the project! Please feel free to submit a Pull Request.

Adding New Function Modules

To facilitate the addition of new automation tools, please follow these steps:

1. Create a new tool class file in the src/tools directory.
2. Implement the corresponding business logic and interface adaptation.
3. Update the main program to support the invocation of the new function.