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: Uses DeepAgents' built-in code search tools

📦 Quick Start

Installation

Get your API key at Anthropic Console

Basic Usage

Python API

📚 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? Upgrade deepagents and reinstall CodeViewX dependencies
- More questions? See docs/en for complete documentation

🤝 Contributing

Contributions are…