codeviewx

CodeViewX

AI-Powered Code Documentation Generator

中文 | English

CodeViewX automatically analyzes your codebase and generates professional technical documentation using AI (Anthropic Claude + DeepAgents + LangChain).

✨ Key Features

• 🤖 AI-Powered Analysis: Automatically understands code structure and business logic
• 📝 Complete Documentation: Generates 8 standard chapters (overview, quick start, architecture, core mechanisms, data models, API reference, development guide, testing)
• 🌐 Multi-Language: Supports Chinese, English, Japanese, Korean, French, German, Spanish, Russian
• 🖥️ Documentation Browser: Built-in web server for elegant documentation display
• ⚡ Fast Search: Integrated ripgrep for high-speed code search

📦 Quick Start

Installation

# Install CodeViewX
pip install codeviewx

# Install ripgrep (code search tool)
brew install ripgrep  # macOS
# sudo apt install ripgrep  # Ubuntu/Debian

# Configure API Key and base url
export ANTHROPIC_AUTH_TOKEN='your-api-key-here'
export ANTHROPIC_BASE_URL='https://api.anthropic.com/v1'

Get your API key at Anthropic Console

Basic Usage

# Generate documentation for current directory
codeviewx

# Specify project path and language
codeviewx -w /path/to/project -l English -o docs

# Start documentation browser
codeviewx --serve -o docs

Python API

from codeviewx import generate_docs, start_document_web_server

# Generate documentation
generate_docs(
    working_directory="/path/to/project",
    output_directory="docs",
    doc_language="English"
)

# Start web server
start_document_web_server("docs")

📚 Documentation

For complete documentation, visit the docs/en directory:

• 📖 Overview - Tech stack and project structure
• 🚀 Quick Start - Detailed installation and configuration
• 🏗️ Architecture - Architecture design and components
• ⚙️ Core Mechanisms - Deep dive into how it works
• 🔌 API Reference - Complete API documentation
• 👨‍💻 Development Guide - Development and contribution guide
• 🧪 Testing - Testing strategies and examples
• 🔒 Security - Security best practices
• ⚡ Performance - Performance optimization
• 🚀 Deployment - Deployment guide
• 🔧 Troubleshooting - Common issues and solutions

🔧 Troubleshooting

Having issues? Check the detailed documentation for help.

Quick Tips:

• API key error? Ensure ANTHROPIC_AUTH_TOKEN environment variable is set correctly
• Search not working? Check if ripgrep is installed
• More questions? See docs/en for complete documentation

🤝 Contributing

Contributions are welcome! See Contributing Guide for details.

📄 License

GNU General Public License v3.0 - see LICENSE file.

🙏 Acknowledgments

Built with Anthropic Claude, DeepAgents, LangChain, and ripgrep.

⭐ Star this project if you find it helpful!