🤖 Claudux — Your docs write themselves

Stop fighting stale documentation. Claudux analyzes your codebase and generates comprehensive, navigable docs that actually stay in sync with your code.

⭐ If this saves you time, please star it! Your support helps us build better tools for developers.

Claudux documentation site screenshot

😤 The Problem Every Developer Knows

Documentation debt is killing your productivity. You ship features, but docs lag behind. New team members struggle to onboard. You spend weekends writing docs instead of building.

✨ The Solution

Claudux uses Claude AI to understand your codebase and generate production-ready documentation that:

🔄 Stays current - Updates with your code, not months later
🧠 Actually understands - Analyzes structure, patterns, and context
⚡ Ships fast - One command generates complete VitePress sites
🔒 Runs locally - Your code never leaves your machine
🍰 Zero config - Works out of the box, customize if needed

Meta proof: Claudux's own docs are generated by Claudux. We use our own tool daily.

🌟 Get started in 30 seconds

# Install globally
npm install -g claudux

# Generate docs for your project
cd your-project
claudux update

# Preview locally  
claudux serve  # http://localhost:5173

🎬 See it in action

$ claudux update
📊 Analyzing codebase...
📋 Planning documentation structure...
✍️  Generating pages...
🔗 Validating links...
✅ Documentation ready! Run 'claudux serve' to preview

The transformation:
• Scattered README files → Organized documentation site
• Manual maintenance → Automated updates
• Broken links → Validated navigation
• Generic templates → Code-aware content

📚 Documentation

📖 Live Documentation - Browse online with full search & navigation
Browse in-repo: docs/index.md
Preview locally: claudux serve - http://localhost:5173

🧠 How it works

Claudux uses a two‑phase flow to produce reliable docs:

Plan: analyze source code and produce a navigable outline + VitePress config
Write: generate pages with correct links, breadcrumbs, and cross‑references

🎨 Features

Code‑driven: content comes from your actual project structure
Smart cleanup: semantic obsolescence detection (not just regex)
VitePress‑ready: clean config, search, edit links, and sensible defaults
Zero cloud lock‑in: everything runs locally; keep your code private

✅ Requirements

Node.js ≥ 18
Claude CLI installed and authenticated (claude config get)

🛠️ Commands

claudux                     # Interactive menu
claudux update              # Generate/update docs (includes cleanup & validation)
claudux update -m "..."     # Update with focused directive for Claude
claudux serve               # Start dev server (localhost:5173)
claudux recreate            # Start fresh (delete all docs)
claudux create-template     # Analyze codebase and generate CLAUDE.md

# Full usage
claudux --help

🔧 Configuration

Create a claudux.json in your project root:

{
  "project": {
    "name": "Your Awesome Project",
    "type": "javascript"
  }
}

README hero image: place assets/readme-hero.png (1600×900 recommended; .webp preferred)
Optional social card for docs: place docs/public/og-image.png and add OG meta in VitePress config

🤝 Contributing

We welcome contributions. See CONTRIBUTING.md.

📄 License

MIT — see LICENSE for details.

Keep your docs as fresh as your code.
📖 Live Documentation • 📦 Install from npm • ⭐ Star on GitHub • 🐛 Report issues

Package detail

readme