A living wiki for your code, your agents, and you.
OpenWiki turns your codebase and knowledge sources into a linked Markdown wiki that you own. Your coding agent can use it to understand a repository, answer questions, and find context across related projects. You can read the same pages or explore them as an interactive graph.
For repository wikis, OpenWiki tracks facts back to source evidence so updates can focus on what changed. Start inside your coding agent, or use the standalone CLI for repository docs, personal knowledge, and scheduled updates.
Get started · Search and link wikis · Explore · Standalone CLI · Command reference
🎉 What's new
- Linked wiki workspaces: group related repositories with
openwiki link, search across their wikis, and read relevant sections through MCP. See how it works →
- More coding-agent integrations: Oh My Pi, Antigravity, IBM Bob / Bob Shell, and Kiro join Codex, Claude Code, OpenCode, GitHub Copilot and Cursor. Connect your agent →
- Parallel page workers: native CLI runs can now document multiple pages concurrently while saving progress page by page and adapting to provider rate limits. Configure concurrency →
- Resumable updates and grounded Claims: completed pages survive interruptions, and versioned source evidence identifies facts that need attention. Explore the architecture →
Portable OKF v0.2 output and publishable visualizers are also available.
Quick start
The easiest way to get started is inside the coding agent you already use. OpenWiki uses that agent's authenticated model session and repository tools, so there is no separate model provider to configure.
1. Install OpenWiki
You'll need Node.js 22.22.0 or newer.
npm install -g openwiki
If you use Pi, install the package through Pi in step 2 instead; a separate
global OpenWiki installation is not required.
2. Connect your coding agent
Choose the integration for your agent:
| Coding agent | Install |
|---|
| Codex | openwiki integrations install codex |
| Claude Code | openwiki integrations install claude |
| OpenCode | openwiki integrations install opencode |
| Cursor | openwiki integrations install cursor |
| IBM Bob / Bob Shell | openwiki integrations install bob |
| Kiro | openwiki integrations install kiro |
| Oh My Pi | openwiki integrations install omp |
| Antigravity | openwiki integrations install antigravity |
| GitHub Copilot CLI | openwiki integrations install copilot |
| Pi | pi install npm:openwiki |
3. Create your wiki
Restart your coding agent, open a repository, and ask:
Initialize this repository's OpenWiki from the current source and tests.
Your agent researches the repository and writes a linked wiki in openwiki/. OpenWiki tracks its source evidence and saves progress as each page completes.
Once your wiki is ready, ask questions, link related repositories, or explore it visually.
All integrations install at user level by default, so one installation works from any Git repository. Use openwiki integrations list to inspect installation status or openwiki integrations uninstall <host> to remove an integration safely. Add --project [path] to list, install, or uninstall for repository-scoped state; project paths resolve to their Git repository root.
Host-specific locations and notes:
- OpenCode uses
~/.config/opencode.
- IBM Bob / Bob Shell uses
~/.agents/skills and ~/.bob/settings/mcp.json at user scope; .agents/skills and .bob/mcp.json at the project.
- Kiro uses
~/.kiro/skills and ~/.kiro/settings/mcp.json.
- Oh My Pi uses
~/.omp/agent at user scope (the default profile). Use --project for named profiles or a relocated PI_CODING_AGENT_DIR.
- Antigravity uses
~/.gemini/antigravity-cli/skills and ~/.gemini/config/mcp_config.json.
- GitHub Copilot CLI uses
~/.copilot/skills and ~/.copilot/mcp-config.json at user scope; .github/skills and .github/mcp.json at the project.
- Pi is separate from Oh My Pi. Pi loads OpenWiki's skill, four read-only retrieval tools, and six lifecycle tools from the npm package; use
pi install --local npm:openwiki for a project-local install. Its extension starts the package's own CLI through Node, so openwiki need not be on PATH. Pi is not a target of openwiki integrations install.
On Windows, install with a Node.js package manager (npm install -g openwiki or pnpm add -g openwiki). Installing with bun can fall back to compiling the better-sqlite3 native dependency, which needs Visual Studio Build Tools with the Desktop development with C++ workload.
This is the beginning of the README. Read the rest at the original. Read the full README ↗
