Commands

Quick Start

# Step 1: Configure your LLM provider
wakawiki --init

# Step 2: Generate documentation (interactive)
wakawiki

# Or: One-shot non-interactive
wakawiki -p "Summarize the architecture of this project"

# Or: Update existing documentation
wakawiki --update

CLI Reference

wakawiki [OPTIONS] [PROMPT]

Option	Description
--init	Interactive setup: choose provider, set API key, pick model
-p, --print	Non-interactive one-shot mode (CI-friendly)
--scan	Heuristic scan (no LLM) — fast, deterministic docs
--update	Refresh existing wakawiki/ docs with incremental diff
-h, --help	Show help
--version	Print version and exit

Interactive Mode

Running wakawiki without -p starts an interactive chat session with the LLM agent. You can guide the documentation process by asking questions or giving instructions.

wakawiki
# > Please focus on the API layer
# > Add more detail about error handling
# > Generate mermaid diagrams for the architecture

One-Shot Mode

Use -p / --print for non-interactive, single-prompt runs. This is ideal for scripts and CI pipelines.

wakawiki -p "Document the public API surface"

Incremental Updates

Once you have an existing wakawiki/ directory, run --update to refresh only the files that changed since the last run. This avoids regenerating everything from scratch.

wakawiki --update

Heuristic Scan Mode

Run --scan for instant, deterministic documentation without an LLM. Ideal for CI or when you just need a structural overview.

wakawiki --scan

The scan mode:

• Parses Rust source files for pub items and doc comments
• Reads project metadata from Cargo.toml
• Generates index.md (dependencies, directory tree) and architecture.md (API reference)
• Respects your .gitignore for file filtering
• Runs in milliseconds