Commands Reference

Core Commands

claudux update

Generate or update documentation by analyzing your codebase.

claudux update

With focused directive:

claudux update -m "Add API documentation for new endpoints"
claudux update --with "Focus on the authentication module"

Process:

1. Loads project configuration and selects a project profile
2. Validates docs-structure.json when present and builds the static index
3. Invokes the selected backend once
4. Enforces the default source boundary or applies the manifest patch batch
5. Validates local routes, Markdown links, assets, and anchors
6. Refreshes deterministic state only after the successful path completes

Options:

claudux update -m "message"     # Focused directive
claudux update --with "message" # Same as -m
claudux update --strict         # Re-prompt (then error) on broken internal links

claudux serve

Start the VitePress development server to preview documentation locally.

claudux serve

• Opens at http://localhost:5173
• Hot reload when files change
• Never invokes Claude or Codex
• Creates missing VitePress support files when needed
• Runs npm install --no-audit --no-fund when docs dependencies are missing

Utility Commands

claudux check

Validate your environment and dependencies.

claudux check

Checks:

• Node.js version (>=18 required)
• Active backend (Claude or Codex)
• Backend CLI installation and authentication
• Documentation directory status

For current Codex CLIs, authentication uses codex login status. The compatibility path for older CLIs may run a small codex exec probe, which can consume provider tokens even though check never generates documentation.

claudux --help

Display help information and usage examples.

claudux --help
claudux help
claudux -h

claudux --version

Show the installed claudux version.

claudux --version
claudux version
claudux -V

Interactive Mode

Run claudux without arguments to access the interactive menu:

claudux

The menu adapts based on whether documentation already exists:

First run (no docs):

• Generate docs (scan code -> markdown)
• Serve (VitePress dev server)
• Exit

Existing docs:

• Update docs (regenerate from code)
• Update (focused) (enter directive -> update)
• Serve (VitePress dev server)
• Exit

Advanced Usage

Backend Selection

Switch between AI backends using environment variables:

# Default -- uses Claude
claudux update

# Use Codex instead
CLAUDUX_BACKEND=codex claudux update

# Or export for the session
export CLAUDUX_BACKEND=codex
# Optional overrides; omit both to use the authenticated Codex default.
export CODEX_MODEL=gpt-6-astra
export CODEX_REASONING_EFFORT=xhigh
claudux update

Environment Variables

Control model selection and behavior:

# Force specific Claude model
FORCE_MODEL=opus claudux update
FORCE_MODEL=sonnet claudux update  # Default

# Pre-set directive message
CLAUDUX_MESSAGE="Focus on API docs" claudux update

Command Workflow

Typical development cycle:

# Initial setup
claudux update

# Make code changes
# ... edit your source files ...

# Update docs to reflect changes
claudux update

# Preview changes
claudux serve

# Focused updates for specific changes
claudux update -m "Document the new authentication flow"

Exit Codes

Claudux follows standard Unix exit code conventions:

• 0: Success
• 1: General error
• 2: Incorrect usage, or an environment error the command could not evaluate
• 124: Timeout
• 130: Interrupted (Ctrl+C)

Use in CI/CD:

claudux update || exit 1  # Fail build if docs generation fails