A CLI tool that generates README files for your repository using LLMs, or offline without an API key.
langchain-ai/openwiki
A CLI that writes and maintains a linked Markdown wiki for your codebase, grounded in source evidence, for your coding agents and you.
- Stars
- 17,800
- Forks
- 1,315
- Open issues
- 175
- Last commit
- 13 hours ago
What is it?
OpenWiki turns a repository and its knowledge sources into a linked Markdown wiki that stays in your repo as plain files. Coding agents can use it to understand the codebase, answer questions, and find context across related projects, and readers can browse the same pages or view them as an interactive node graph.
For repository wikis, each factual claim is tied to versioned source evidence, so when code changes OpenWiki can limit updates to the facts that are affected. Updates skip model work when nothing has changed, and interrupted runs resume from the completed pages.
OpenWiki can be started from inside supported coding agents such as Codex, Claude Code, Cursor and GitHub Copilot CLI, or run as a standalone CLI with a choice of model providers. It also includes a personal mode that synthesizes local knowledge from connectors such as Notion, Gmail and Hacker News, and can be scheduled in CI to open documentation pull requests.
Key features
- 01Generates a linked Markdown wiki inside the repository that you can edit and version.
- 02Ties page facts to source evidence so updates target only the claims affected by code changes.
- 03Integrates with several coding agents and exposes search and read tools over MCP.
- 04Supports linking multiple repositories into workspaces for cross-project search.
- 05Provides a local visualizer with an interactive graph and live Markdown reader, plus static export.
- 06Works with a range of model providers, including OpenAI-compatible local endpoints.
Use cases
- Giving a coding agent a maintained overview of a large or unfamiliar repository.
- Keeping onboarding and architecture docs current through scheduled CI update PRs.
- Documenting a multi-repository service as one searchable workspace.
- Publishing a browsable architecture graph alongside generated documentation.
Quick start
- 1
Install OpenWiki globally with npm (requires Node.js 22.22.0 or newer)
npm install -g openwiki - 2
Connect your coding agent (example for Codex; other agents have their own install command)
openwiki integrations install codex - 3
Restart your coding agent, open a repository, and ask it to initialize the OpenWiki from the source and tests
- 4
Explore the generated wiki as an interactive graph in your browser
openwiki visualize
Things to know
- Requires Node.js 22.22.0 or newer.
- The easiest workflow depends on a supported coding agent, and host-driven runs only support repository code wikis, not personal brains.
- On Windows, bun can fall back to compiling the better-sqlite3 native dependency, which needs Visual Studio Build Tools.
Featured in Repolode Weekly
- Issue #3 · Big MoE models streamed from SSD, and millisecond Rust rebuilds
A CLI that writes a linked Markdown wiki inside your repo for coding agents and humans. Facts are tied to source evidence, so code changes only update the affected claims.
In collections
Topics
FAQ
- What is openwiki?
- A CLI that writes and maintains a linked Markdown wiki for your codebase, grounded in source evidence, for your coding agents and you. OpenWiki turns a repository and its knowledge sources into a linked Markdown wiki that stays in your repo as plain files. Coding agents can use it to understand the codebase, answer questions, and find context across related projects, and readers can browse the same pages or view them as an interactive node graph.
- Is openwiki free to use? What license does it have?
- openwiki is open source under the MIT license. Check the license terms before using it in commercial products.
- Is openwiki still maintained?
- Actively maintained. The last commit to openwiki was on Nov 7, 2026.
- What can I use openwiki for?
- Giving a coding agent a maintained overview of a large or unfamiliar repository. Keeping onboarding and architecture docs current through scheduled CI update PRs. Documenting a multi-repository service as one searchable workspace. Publishing a browsable architecture graph alongside generated documentation.
- How do I install openwiki?
- Install OpenWiki globally with npm (requires Node.js 22.22.0 or newer): npm install -g openwiki Connect your coding agent (example for Codex; other agents have their own install command): openwiki integrations install codex Restart your coding agent, open a repository, and ask it to initialize the OpenWiki from the source and tests Explore the generated wiki as an interactive graph in your browser: openwiki visualize
- Where can I get openwiki?
- The source code and installation instructions are on GitHub: https://github.com/langchain-ai/openwiki
Summary generated by AI from the project's README. GitHub stats refresh daily.
Related projects
Open-source collaborative wiki and documentation software, positioned as a self-hostable alternative to Confluence and Notion.
Open-source AI tool that turns Git repos, ZIP archives, and local folders into generated docs, searchable chat, and MCP-accessible knowledge bases.
A local-first Markdown memory workspace that lets AI agents store, search, and consolidate long-term knowledge as editable files.
A personal context store that gives AI coding agents like Codex, Claude Code and OpenCode persistent project knowledge via a CLI, MCP server and desktop app.
Indexes multi-language codebases into a knowledge graph so you can query, search, and edit code in plain English via an AI agent or MCP server.