OpenWiki is a command-line tool that writes and maintains a documentation wiki. An agent reads your sources, synthesizes a linked Markdown wiki that stays in your repository, and updates it as things change. It runs in one of two modes: code, which documents the current repository into an openwiki/ directory, and personal, which documents your connected sources into ~/.openwiki/wiki.
Repository generation is an ordered queue of independently durable page jobs — begin, submit a plan, take the next page, submit it, finish — with a run file that checkpoints progress. A page advances only once its Markdown, claims, verification, and manifest entry are all persisted, so an interrupted run resumes from where it stopped and ephemeral CI runs can still open partial-progress pull requests.
Factual pages carry grounded claims: material propositions about behaviour, architecture, data flow, invariants, failure semantics, configuration, and security boundaries, each pointing at exact repository evidence such as a file and line range plus the version observed at the time. Before an update, OpenWiki rechecks every recorded evidence version and hands the page worker only the claims that need attention, so stale documentation is detected from changed evidence rather than from file timestamps.
Instead of launching its own model, OpenWiki can run inside a coding agent that already has repository tools and an authenticated model, while OpenWiki supplies the durable page-job lifecycle over MCP and finalizes claims, indexes, provenance, and metadata. On its own it supports thirteen model providers, and a connector set feeds personal wikis from Custom MCP servers, local git repositories, Notion, Slack, Gmail, X, web search, and Hacker News; a separate connector enriches a code wiki with runtime trace data.
Output is an Open Knowledge Format bundle with validated Mermaid diagrams. An openwiki visualize command serves the wiki as an interactive node graph beside a live Markdown reader on a loopback address, or exports it as a static site for any static host. Scheduled GitHub Actions, GitLab CI, or Bitbucket Pipelines jobs open a documentation pull request whenever the wiki changes.
Features
- Two modes: a code wiki for the current repository, or a personal wiki for your own connected sources
- Resumable generation: a durable ordered page queue with per-page checkpoints survives interruptions and CI failures
- Grounded claims: material facts link to versioned repository evidence and are rechecked before each update
- Coding-agent integrations: run inside an existing agent, using its model and repository tools
- Model providers: thirteen providers, from hosted APIs to any OpenAI-compatible gateway
- Connectors: Custom MCP, local git repositories, Notion, Slack, Gmail, X, web search, and Hacker News
- Runtime trace enrichment: a trace connector documents how the code behaves at runtime, not only what the source says
- Interactive visualizer: a node graph with a side-by-side Markdown reader, servable locally or exported as a static site
- Open Knowledge Format: portable OKF v0.2 bundles with generation provenance and validated Mermaid diagrams
- Agent memory files: maintains delimited blocks in AGENTS.md and CLAUDE.md pointing agents at the wiki
- CI self-update: scheduled GitHub Actions, GitLab CI, or Bitbucket Pipelines jobs open a docs pull request on change
- Local state: credentials, connector data, history, and skills live under a configurable state directory
