OpenWiki
OpenWiki is a CLI that automatically writes and maintains a Markdown wiki for your codebase or personal knowledge. It uses an agent to synthesize linked documentation from your sources and keeps it current as changes occur. It is designed for developers who want agent-friendly, self-updating documentation that can be explored by humans.
✨ Key features
- Agent-written docs that stay accurate
- Two modes: code wiki and personal wiki
- Thirteen model providers supported
- Coding-agent integrations for Codex, Claude Code, OpenCode, Cursor
- Grounded Claims track facts to source evidence
- Interactive visualizer for exploring wiki as node graph
🎯 Use cases
- Generate and maintain a wiki for a software repository
- Create a personal knowledge base from connected sources like Notion, Gmail, Slack
- Automate documentation updates via CI/CD pipelines
- Explore codebase architecture through an interactive graph
- Integrate documentation generation into coding agent workflows
📦 Installation
🧰 Requirements: Node.js 22 or newer. API keys may be required for certain model providers or connectors.
npm install -g openwiki
🚀 Usage
openwiki --init
This generates a wiki for the current repository, prompting for provider and model on first run.
⚠️ Good to know
Grounded Claims currently apply only to repository code wikis, not connector-derived facts. External coding-agent integrations use only repository source and tests, not connector-sourced context.
❓ FAQ
What are the two modes of OpenWiki?
Code mode (default) documents the current repository into openwiki/, while personal mode documents your connected sources into ~/.openwiki/wiki.
How does OpenWiki keep documentation up to date?
It uses a self-updating mechanism via scheduled CI jobs (GitHub Actions, GitLab CI, Bitbucket Pipelines) that run openwiki --update and open a docs PR when changes occur.
Can I use OpenWiki with my existing coding agent?
Yes, OpenWiki provides integrations for Codex, Claude Code, OpenCode, and Cursor, allowing the agent to use its own model and repository tools while OpenWiki manages the documentation lifecycle.
What are Grounded Claims?
Grounded Claims track material facts in code wikis back to versioned source evidence, so when evidence changes, OpenWiki knows which claims need to be confirmed, rewritten, or retired.
📊 Repository
🤖 Overview, features, install steps and FAQ were generated from the project's README on Sep 4, 2026. Always check the original source before running commands.