Command reference

OpenWiki command-line usage, flags, and connector subcommands

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

# Link repository wikis into a workspace
openwiki link
openwiki workspace use payments
openwiki workspace current
openwiki workspace clear

# Coding-agent integrations
openwiki integrations list
openwiki integrations install codex
openwiki integrations install omp
openwiki integrations install antigravity
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.
--debug	Print fuller failure detail, including the innermost cause behind wrapped errors such as “Connection error.”
--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.

Search and link

Group related repository wikis and manage the active search workspace:

openwiki link [directory]
openwiki workspace use <name>
openwiki workspace current
openwiki workspace clear

For MCP search and read tools, workspace scope rules, and examples, see Search and link wikis.

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|bob|kiro|omp|antigravity> [--force] [--project [path]]
openwiki integrations uninstall <codex|claude|opencode|cursor|bob|kiro|omp|antigravity> [--project [path]]

For details, see Coding-agent integrations.

Native CLI runs can raise page worker concurrency with OPENWIKI_PAGE_CONCURRENCY (1 to 8, default 1). See Parallel page workers.

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, NVIDIA NIM, Gemini, and opted-in openai-compatible models, or /effort default to restore the provider default
• /init and /update: Launch init or update from the session
• /exit: Exit the app

See also

• Coding-agent integrations
• Search and link wikis
• Personal mode
• Model providers
• Automate updates

---

Connect these docs to your agent of choice via MCP for real-time answers.

Edit this page on GitHub or file an issue.