CLI Commands

KodaDocs provides a set of CLI commands for power users who want to run the pipeline directly without Claude Code.

kodadocs

Running kodadocs with no subcommand displays version info and usage instructions:

kodadocs

Options:

• --version — display the current version and exit

kodadocs generate

Run the full documentation pipeline.

kodadocs generate [PATH] [OPTIONS]

Arguments:

• PATH — project directory (default: current directory)

Options:

Option	Description
--url, -u	Override app URL for screenshot capture
--fresh	Ignore cached configuration and manifest; re-run everything from scratch
--user	WordPress admin username (for WordPress sites)
--pass	WordPress admin password
--deploy	Deploy to hosting provider after generation

Examples:

# Generate docs for current project
kodadocs generate .

# Generate with app running at a specific URL
kodadocs generate . --url http://localhost:8080

# Fresh run, ignoring any cached state
kodadocs generate . --fresh

# Generate and deploy in one step
kodadocs generate . --deploy

# WordPress site with authentication
kodadocs generate . --url https://mysite.com --user admin --pass secret

What happens:

1. Auto-detects framework if no config exists
2. Loads or creates session configuration
3. Runs Discovery → Analysis → Capture → Annotation → Enrichment → Output steps
4. Skips already-completed steps (use --fresh to force re-run)
5. Outputs a VitePress site to ./docs/

kodadocs init

Interactive setup wizard for advanced configuration.

kodadocs init [PATH] [OPTIONS]

Options:

• --output — path to save generated documentation (default: ./docs)

The wizard prompts for:

• App URL for screenshots
• Authentication credentials (if needed)
• Include/exclude file patterns
• Brand color (hex)
• Theme preset selection
• Logo path
• AI model preference

Configuration is saved to .kodadocs/session_config.json.

kodadocs config

View or update saved configuration.

kodadocs config [PATH] [OPTIONS]

Options:

Option	Description
--show, -s	Pretty-print current configuration
--url	Update app URL
--brand-color	Update brand color (hex)
--logo	Update logo path
--model	Update AI model
--output	Update output path
--framework	Update framework

Examples:

# View current config
kodadocs config . --show

# Update brand color
kodadocs config . --brand-color "#ff6600"

# Change AI model
kodadocs config . --model claude-sonnet-4-6

kodadocs deploy

Deploy the generated documentation site.

kodadocs deploy [PATH] [OPTIONS]

Options:

Option	Description
--provider, -p	Hosting provider: cloudflare, vercel, netlify, github-pages, kodadocs
--output, -o	Override docs output directory
--license-key	KodaDocs Pro license key (for hosted deployment)
--slug	Site subdomain for *.kodadocs.com hosting

Examples:

# Deploy to Cloudflare Pages
kodadocs deploy . --provider cloudflare

# Deploy to Vercel
kodadocs deploy . --provider vercel

# Deploy to KodaDocs hosted (Pro)
kodadocs deploy . --provider kodadocs --license-key kd_pro_xxx --slug my-app

kodadocs update

Incrementally update existing documentation. Only re-captures and rewrites articles for routes that changed.

kodadocs update [PATH] [OPTIONS]

Options:

Option	Description
--url, -u	Override app URL
--routes, -r	Force re-capture specific routes (comma-separated)
--deploy / --skip-deploy	Deploy after update (default: skip)

Examples:

# Update docs after app changes
kodadocs update .

# Force re-capture specific routes
kodadocs update . --routes /dashboard,/settings

# Update and deploy
kodadocs update . --deploy

kodadocs mcp

Start the MCP server for Claude Code integration.

kodadocs mcp

This is typically called automatically by Claude Code via the MCP server configuration, not run manually.