Command reference

OpenWiki ships as a single openwiki binary for interactive chat and one-shot documentation runs. For installation and first use, see Quickstart.

Core commands

# Interactive chat in code mode (current repository)
openwiki
openwiki "Please generate documentation for this repository"

# Personal mode
openwiki personal
openwiki personal --init
openwiki personal --update

# Explicit code mode
openwiki code --init
openwiki code --update
openwiki code --update --print

# Defaults to code mode and specify a language
openwiki --init
openwiki --update
openwiki --init --language ko

# One-shot print mode
openwiki -p "Summarize what you can do"

# Explore the wiki locally or export a static visualizer
openwiki visualize
openwiki visualize openwiki --port 4400 --no-open
openwiki visualize openwiki --export docs/openwiki-visualizer

# Coding-agent integrations
openwiki integrations list
openwiki integrations install codex
openwiki integrations install claude
openwiki integrations install opencode
openwiki integrations install cursor
openwiki integrations uninstall codex

# Help
openwiki --help

Common flags

Flag	Description
`--init`	Generate initial documentation. Defaults to code mode. Re-running regenerates the repository wiki from scratch while preserving `openwiki/INSTRUCTIONS.md`. In a TTY without `--print`, streams agent output and exits automatically on success. `--init` and `--update` cannot be combined.
`--update`	Update existing documentation. Defaults to code mode. In a TTY without `--print`, streams agent output and exits automatically on success. `--init` and `--update` cannot be combined.
`-l`, `--language <locale>`	Generate wiki documentation in the given BCP-47 locale, for example `ko`, `zh-CN`, or `pt-BR`. Unrecognized values are rejected.
`--mode <personal\|code>`	Choose personal brain or repository docs.
`-p`, `--print`	Run once, print the final assistant output, and exit. Provide a message or command. Interactive chat without `--print` stays open for follow-ups.
`--modelId` / `--model-id`	Choose a model ID for the run.
`--telemetry-file=<path>`	Also write the telemetry payload for the run to a local JSON file.
`-h`, `--help`	Print usage.

Visualize

You can visualize the generated wiki as an interactive node graph and live Markdown reader, or export a static site for hosting:

openwiki visualize
openwiki visualize openwiki --port 4400 --no-open
openwiki visualize openwiki --export docs/openwiki-visualizer
openwiki visualize ~/.openwiki/wiki

For details, see Visualize your wiki.

Coding-agent integrations

Install OpenWiki into a host coding agent so the host’s model and repository tools drive generation while OpenWiki owns the durable page-job lifecycle:

openwiki integrations list [--project [path]]
openwiki integrations install <codex|claude|opencode|cursor> [--force] [--project [path]]
openwiki integrations uninstall <codex|claude|opencode|cursor> [--project [path]]

For details, see Coding-agent integrations.

Auth and connectors

# List supported auth providers and status
openwiki auth

# Browser OAuth; save tokens to ~/.openwiki/.env and create connector config when possible
openwiki auth gmail
openwiki auth notion
openwiki auth slack
openwiki auth x

# Regenerate connector config from saved auth env vars
openwiki auth configure <provider> [--force]

# List live MCP tools for MCP-backed providers
openwiki auth tools <provider>

# Run source-specific connector ingestion
openwiki ingest <source|source-instance|all>

# HTTPS tunnel for Slack OAuth; saves OPENWIKI_HTTPS_OAUTH_REDIRECT_URI
openwiki ngrok start [url] [--port <port>]

Cron (macOS)

Manage optional connector schedules for personal mode sources. On macOS, OpenWiki can install schedules as user LaunchAgents that periodically refresh a source (for example Gmail or web search). Use these commands to list, pause, resume, or delete them:

openwiki cron list
openwiki cron pause <source|all>
openwiki cron resume <source|all>
openwiki cron delete <source|all>

cron delete removes the saved schedule and unloads its LaunchAgent. It does not remove auth, connector config, raw data, or wiki content.

Slash commands (interactive)

In interactive chat mode, you can use the following commands:

/api-key: Update the current provider API key (masked prompt)
/langsmith-key: Update or clear LangSmith tracing credentials (masked prompt)
/provider and /model: Change provider or model for the session (persisted to ~/.openwiki/.env)
/effort: Set reasoning effort for supported OpenAI GPT-5.6 and NVIDIA NIM models, or /effort default to restore the provider default
/init and /update: Launch init or update from the session
/exit: Exit the app

Modes

Core commands

Common flags

Visualize

Coding-agent integrations

Auth and connectors

Cron (macOS)

Slash commands (interactive)

See also

​Core commands

​Common flags

​Visualize

​Coding-agent integrations

​Auth and connectors

​Cron (macOS)

​Slash commands (interactive)

​See also

Core commands

Common flags

Visualize

Coding-agent integrations

Auth and connectors

Cron (macOS)

Slash commands (interactive)

See also