Command-line workflow
Runs as a CLI rather than a web app, so documentation generation and updates happen from the terminal.
OpenWiki
OpenWiki is a CLI tool for generating and maintaining codebase docs, with agent-focused context. Initialize repo docs, keep them current, and surface them in AGENTS.md and CLAUDE.md.
Overview
OpenWiki is a CLI for generating and maintaining documentation for a codebase, with a specific focus on documentation that helps agents work with that repository. The README describes it as a tool that creates initial documentation, keeps it current as the codebase changes, and adds guidance files that tell coding agents where to look for context.
In practice, OpenWiki is meant to fit into a developer workflow: install it with npm, initialize it in a repository, and then either run it interactively or generate a one-shot summary. The project also includes a GitHub Actions workflow that can open a pull request with documentation updates on a schedule, which makes it easier to keep repository documentation synchronized over time.
What OpenWiki does
Generate and maintain docs
Creates initial documentation in an openwiki/ directory when a wiki does not yet exist, then refreshes that content as the repository changes.
Interactive and print modes
Can stay open after a run for follow-up prompts, or exit immediately with -p / --print for a one-shot output.
Agent-facing prompting
Updates repository guidance files such as AGENTS.md and CLAUDE.md so agents are directed toward the generated documentation.
Multiple model providers
Supports several inference providers out of the box, including OpenRouter, Fireworks, Baseten, OpenAI, and Anthropic.
Local setup and tracing support
Can optionally save configuration and a LangSmith API key locally at ~/.openwiki/.env for tracing runs.
Common use cases
Bootstrapping docs for a repository
Generate a first pass of repository documentation when a new codebase needs a structured starting point for agents and contributors.
Maintaining docs as the codebase evolves
Keep agent-facing documentation aligned with code changes by rerunning OpenWiki or using the repo workflow that opens scheduled update PRs.
Improving agent context discovery
Give coding agents a clearer place to look for context by linking repository guidance files to the generated OpenWiki content.
One-shot documentation runs
Produce a quick summary or documentation snapshot from the terminal without staying in an interactive session.
Repeating the same docs process across repositories
Standardize documentation workflows across projects that rely on the same CLI setup and model-provider configuration.
Pros and Cons
Pros
- Targets agent documentation specifically, not just general project notes.
- Can initialize new documentation and refresh existing docs from repository changes.
- Supports interactive use and non-interactive one-shot output.
- Works with several major inference providers out of the box.
- Can integrate documentation guidance into AGENTS.md and CLAUDE.md files.
Cons
- The source material does not provide a full feature matrix, so some capabilities and limitations are still unclear from the README alone.
- The documentation update workflow depends on GitHub Actions and repository setup, so automatic refreshes are tied to that environment.
FAQ
How do you use OpenWiki?
OpenWiki is installed with npm and started from the command line. The README shows a global install command, then an interactive start or one-shot print mode for generating documentation.
Does OpenWiki create or update documentation?
Yes. The README says OpenWiki can create initial documentation in an openwiki/ directory when no wiki exists, and refresh that documentation from repository changes when the directory already exists.
Which model providers does OpenWiki support?
OpenWiki supports OpenRouter, Fireworks, Baseten, OpenAI, and Anthropic out of the box, and it lets you specify a custom model ID for each inference provider.
How does OpenWiki help other agents find the documentation?
The README says OpenWiki can append prompting to AGENTS.md and/or CLAUDE.md so coding agents know to reference OpenWiki documentation when searching for context.
Is OpenWiki free?
The repository itself is open source on GitHub and uses the MIT license. The GitHub pricing page shows that GitHub offers a free plan with public and private repositories, but that pricing page does not establish a separate paid price for OpenWiki itself.
Quick Facts
- Category
- Developer Tool
- Product type
- CLI
- Primary use
- Agent documentation for codebases
- Installation
- npm install -g openwiki
- License
- MIT
- Repository host
- GitHub
OpenWiki Alternatives
DocsAlot
DocsAlot is an AI-readable documentation platform for startups and SaaS teams to publish hosted docs, llms.txt, skill.md, and hosted MCP from one source.
ByteAsk
ByteAsk is a terminal-first AI coding agent for C and C++ that edits repos and verifies changes with compilers, debuggers, sanitizers, and tests.
hob
hob is an independent workspace for coding agents, with local control over sessions, terminals, history, routing, and follow-up work.
Manta AI
Manta AI is an autonomous web app testing tool that maps app behavior, catches regressions, and generates tests from a URL, no scripts or selectors needed.
Redline
Redline is a budgeting tool for Claude Code that paces sessions by time, tokens, cost, or plan percentage, helping them end with a usable result.
Falconer
Falconer is an AI-powered company brain that keeps internal docs accurate, searchable, and up to date by syncing with GitHub, Slack, and Linear.