AI-assisted documentation generator that analyzes your codebase and updates navigable docs with your code
# Install globally
npm install -g claudux
# Generate docs for your project
cd your-project
claudux update
# Preview locally
claudux serve # http://localhost:5173
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.
Claudux uses a two-phase flow to produce reliable docs:
| Command | Purpose |
|---|---|
claudux | Interactive menu (adapts to project state) |
claudux update | Generate/update docs (includes cleanup and validation) |
claudux update -m "..." | Update with a focused directive |
claudux serve | Start dev server at localhost:5173 |
claudux diff | Files changed since last doc generation |
claudux status | Documentation freshness and last run details |
claudux validate | Check all internal links without regenerating |
claudux recreate | Start fresh (delete all docs) |
claudux check | Environment diagnostics |
claudux template | Generate claudux.md (docs preferences) |
claudux --version | Show installed version |
claudux --help | Show help and usage |
claudux supports multiple AI backends. Claude is the default; Codex is available as an alternative via the CLAUDUX_BACKEND environment variable.
# Default -- uses Claude
claudux update
# Use Codex instead
CLAUDUX_BACKEND=codex claudux update