Skip to content
Get packs

OpenWiki

A CLI that writes and keeps a linked Markdown wiki of your code for coding agents and people.

GitHub Download v0.7.3
Stars
17.7k
Forks
1.3k
Licence
MIT
Language
TypeScript
Last update
4 days ago
Type
CLI

What it is

OpenWiki turns a codebase (and optionally other knowledge sources) into a linked set of Markdown pages you own. Coding agents such as Codex or Claude Code can read these pages to understand a repository, answer questions, and find context across related repositories. People can read the same pages or browse them as an interactive graph.

  • Ask your coding agent to initialize a wiki for a repository in the openwiki/ folder
  • Search a repository's wiki for a concept such as how retry handling works, then read the matching sections
  • Group related repositories with openwiki link and search across their wikis together
  • Schedule or re-run updates so pages reflect changed source

Great for

  • Developers who work in a coding agent and want it to understand large or unfamiliar repositories
  • Teams with several related repositories that want one searchable wiki across them
  • Developers who want repository docs that are kept up to date as the code changes

Not ideal for

  • People who do not use a supported coding agent, since the main workflow runs inside one (the standalone CLI is secondary in the README)
  • Teams needing connector-sourced context such as LangSmith, which the README says host-driven runs do not yet support
  • Anyone needing a hosted service, since the README describes a local tool that writes files into your repository
Step-by-step guide: how to use OpenWikiInstall, first run, examples, tips and FAQs

How to get it

  1. 1

    Install with a package manager

    You'll need: Node.js 22.22.0 or newer · A supported coding agent such as Codex, Claude Code, or Cursor

    Install OpenWiki globally

    npm install -g openwiki

    Connect Codex to OpenWiki (example integration)

    openwiki integrations install codex
  2. 2

    Run it

    • Install OpenWiki with npm and connect your coding agent with openwiki integrations install <agent>
    • Restart your coding agent and open a Git repository
    • Ask the agent: Initialize this repository's OpenWiki from the current source and tests.
    • Wait for the agent to write the wiki into the openwiki/ folder, then ask questions about the code
  3. 3

    Get the most out of it

    • Use openwiki link to group related repositories into a workspace and search across them
    • Use --project when you want integration state scoped to one repository instead of your whole user account
    • Explore the wiki as an interactive graph, not only as Markdown files
    • Use openwiki_search for concrete questions and openwiki_read for the sections it returns, as the README suggests

Downloads

Source code (.zip)main branch · straight from GitHubRelease v0.7.3Release notes and source

Strengths

  • Works with the coding agent you already use, reusing its model session, so no separate model provider setup is described
  • Tracks facts back to source evidence so updates can focus on what changed
  • Writes plain Markdown that you own, and saves progress page by page so interrupted runs can resume

Trade-offs

  • Requires Node.js 22.22.0 or newer and installs into your agent's configuration files, which adds setup steps
  • The README does not document costs or how much model usage a full wiki generation consumes
  • Some integrations and behaviours are still evolving; the README describes recent additions and notes connector support is not yet available for host-driven runs

Stats synced from GitHub. The assessment above was drafted with AI from the project's README on 2026-10-29 and may miss recent changes — check the README before relying on a command. MIT licence: free to use, modify and distribute, including commercially, as long as you keep the copyright notice.