+
Skip to content

leojkwan/claudux

Repository files navigation

claudux

Documentation generator that uses Claude AI to analyze your codebase and create VitePress sites.

See it in action: Live documentation (generated by claudux itself)

npm version License: MIT

Claudux documentation site screenshot

Install

npm install -g claudux

Requirements: Node ≥18, Claude CLI authenticated

Usage

cd your-project
claudux          # Analyze code → generate docs
claudux serve    # Preview at localhost:5173

What it does

  • Scans your source code to understand structure and patterns
  • Generates a complete VitePress documentation site
  • Validates internal links to prevent 404s
  • Runs locally (code doesn't leave your machine)

The generated docs include navigation, search, mobile support, and stay current with your codebase.

Example output

$ claudux update
📊 Starting documentation update...
🧠 Model: Claude Sonnet (fast & capable)
📝 Building prompt for javascript project...
✅ Created docs/guide/index.md
✅ Created docs/api/index.md
🔍 Validating documentation links... ✅ 12/12 valid
📋 Documentation generation complete!

Commands

claudux                 # Interactive menu
claudux update          # Generate/update docs  
claudux update -m "..." # Update with specific focus
claudux serve           # Start dev server
claudux recreate        # Delete docs and start over
claudux --help          # Full options

Configuration

Optional claudux.json in project root:

{
  "project": {
    "name": "Your Project", 
    "type": "react"
  }
}

Auto-detects project type from files (React, Next.js, Python, Go, etc.).

Documentation

Live docs (generated by claudux itself)

License

MIT

点击 这是indexloc提供的php浏览器服务,不要输入任何密码和下载