https://github.com/langchain-ai/openwiki
OpenWiki is a CLI that writes and maintains agent documentation for your codebase.
https://github.com/langchain-ai/openwiki
Last synced: 18 days ago
JSON representation
OpenWiki is a CLI that writes and maintains agent documentation for your codebase.
- Host: GitHub
- URL: https://github.com/langchain-ai/openwiki
- Owner: langchain-ai
- License: mit
- Created: 2026-06-22T23:48:26.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2026-07-06T09:23:19.000Z (18 days ago)
- Last Synced: 2026-07-06T10:03:01.511Z (18 days ago)
- Language: TypeScript
- Homepage:
- Size: 591 KB
- Stars: 6,240
- Watchers: 21
- Forks: 417
- Open Issues: 74
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ccamel - langchain-ai/openwiki - OpenWiki is a CLI that writes and maintains agent documentation for your codebase. (TypeScript)
- awesome-ai-coding - openwiki
README
# OpenWiki
OpenWiki is a CLI that writes and maintains agent documentation for your codebase.
## Install
```sh
npm install -g openwiki
```
## Usage
```sh
# Start the interactive CLI
openwiki
# Run a single command and exit
openwiki "Please generate documentation for this repository"
openwiki -p "Summarize what you can do"
openwiki --init
openwiki --update
openwiki --help
```
`openwiki` creates initial documentation in `openwiki/` when no wiki exists. If `openwiki/` already exists, it refreshes that documentation from repository changes. By default, the CLI stays open after each run so you can send follow-up messages. Use `-p` or `--print` for a one-shot non-interactive run that prints the final assistant output.
On the first interactive run, OpenWiki asks for an OpenRouter API key, lets you pick a default model, and saves both to `~/.openwiki/.env`. A LangSmith API key can also be provided optionally to enable tracing your OpenWiki runs.
See [`examples/openwiki-update.yml`](./examples/openwiki-update.yml) for a GitHub Actions workflow you can copy into a repository for scheduled updates.
## Customizing
OpenWiki runs on OpenRouter models, meaning you can use any model that OpenRouter supports (although we suggest using models with good reasoning and agentic capabilities).
You can pick what model to use by running `/model` in the CLI, and selecting from the list of available models, or setting your own custom model ID.