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 install -g claudux
Requirements: Node ≥18, Claude CLI authenticated
cd your-project
claudux # Analyze code → generate docs
claudux serve # Preview at localhost:5173
- 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.
$ 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!
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
Optional claudux.json
in project root:
{
"project": {
"name": "Your Project",
"type": "react"
}
}
Auto-detects project type from files (React, Next.js, Python, Go, etc.).
Live docs (generated by claudux itself)
MIT