AI驱动的文档

CodeViewXAI 驱动的代码文档生成器

用 AI 自动分析代码库，生成专业技术文档。告别手写文档，让 AI 为你的项目创建完整的文档体系

星标

PyPI

Python 3.8+

GPL-3.0

查看演示文档查看 GitHub

main.py

def

generate_docs(project_path):

# Analyzing codebase...

🤖 AI Analysis in progress...

✓ Code structure analyzed

✓ Architecture detected

✓ API endpoints mapped

✓ Documentation generated!

📄 Overview.md

📄 Architecture.md

📄 API-Reference.md

📄 Quick-Start.md

核心特性

强大的 AI 能力与完善的工具链，为你的项目提供专业的文档解决方案

AI 驱动的智能分析

基于 Anthropic Claude 强大的 AI 能力，自动理解代码结构、业务逻辑和架构设计

支持 8 种语言

支持中文、英文、日文、韩文、法文、德文、西班牙文、俄文，为全球团队服务

内置 Web 服务器

一键启动美观的文档浏览器，支持 Markdown 渲染和目录导航

工作流程

三步即可为你的项目生成完整的技术文档

安装配置

通过 pip 安装 CodeViewX 并配置 API 密钥

Terminal

pip install codeviewx
export ANTHROPIC_AUTH_TOKEN='your-api-key'
export ANTHROPIC_BASE_URL='https://api.anthropic.com/v1'

运行生成

指定项目路径和目标语言，一键生成文档

Terminal

codeviewx -w /path/to/project -l Chinese

浏览文档

启动内置 Web 服务器，在浏览器中查看文档

Terminal

codeviewx --serve -o docs

使用场景

适用于各种开发场景，解决文档难题

新人入职快速上手

新开发者通过 AI 生成的文档快速理解项目架构和业务逻辑

开源项目维护

自动为开源项目生成专业文档，提升项目质量和社区参与度

技术债务管理

为缺少文档的老项目补充完整文档，降低维护成本

多语言团队协作

为不同语言团队自动生成对应语言的文档，打破语言障碍

代码示例

支持命令行和 Python API 两种使用方式

# 生成文档
codeviewx -w /path/to/project -l English -o docs

# 启动浏览器
codeviewx --serve -o docs

技术栈

基于业界领先的 AI 和开发工具构建

Anthropic Claude

AI 引擎

DeepAgents

AI Agent 框架

LangChain

LLM 应用框架

Python 3.8+

运行环境

Flask

Web 服务器

快速开始

安装 CodeViewX

pip install codeviewx

获取 API 密钥

访问 Anthropic Console 获取你的 API 密钥

console.anthropic.com

生成文档

codeviewx -w /path/to/project -l Chinese

查看完整文档

准备好为你的项目生成专业文档了吗？

立即开始使用 CodeViewX，让 AI 为你的代码库创建完整的文档体系

查看 GitHub