Get started
Install the CLI, then initialize documentation for the current repository:Modes
OpenWiki has two modes:
Bare
openwiki --init and openwiki --update run in code mode. Use openwiki personal --init or openwiki personal --update for the personal wiki.
Capabilities
Repository wikis
Generate Markdown docs under
openwiki/, then wire them into AGENTS.md and CLAUDE.md so coding agents can find them.Coding-agent integrations
Run OpenWiki inside Codex, Claude Code, OpenCode, or Cursor using the host model and repository tools.
Personal brain
Build a local wiki from git repos, Custom MCP, Gmail, Notion, web search, Hacker News, and X/Twitter.
Grounded Claims
Track material facts back to versioned source evidence and refresh pages when that evidence changes.
Automatic updates
Refresh docs from GitHub Actions, GitLab CI, or Bitbucket Pipelines and open a PR when content changes.
Model providers
Use OpenAI, Anthropic, Gemini, Bedrock, OpenRouter, GitHub Copilot, and other providers out of the box.
Open Knowledge Format
Emit OKF v0.2 Markdown bundles with front matter, indexes, and linked concepts.
LangSmith tracing
Trace documentation runs with LangSmith.
Next steps
Quickstart
Install OpenWiki, configure a provider, and generate your first wiki.
CLI reference
Review commands, flags, and connector subcommands.
Connect these docs to Claude, VSCode, and more via MCP for real-time answers.

