openwiki
OpenWiki is a CLI that writes and maintains agent documentation for your codebase.
What is it?
What it is
OpenWiki is a command‑line interface that automatically writes and maintains documentation for a codebase, designed to work with AI agents.
Why it exists
It exists to keep project documentation up‑to‑date without manual effort, enabling agents to reference accurate docs and allowing continuous integration to generate PRs or merge requests with updated documentation.
Who should use it
Developers needing automated documentationTeams maintaining codebases with agentsUsers of LangChain or agent-based workflows
Who should avoid it
Users preferring manual documentationThose without API access to supported providersNon-technical users
How it works
A quick walkthrough in plain English
How openwiki works
Step 1 of 3
You interact with it
Open openwiki, send a request, or connect it to your stack.
Features
Advantages
- Saves time with automated documentation
- Agent-optimized workflow integration
- Flexible LLM provider support
- CI automation ensures up-to-date docs
- Customizable for self-hosted or proxy setups
- MIT license for open-source use
Disadvantages
- CLI may require technical expertise
- Setup involves API key configuration
- Dependent on third-party LLM providers
- CI integration requires workflow setup
- Initial configuration can be time-consuming
Installation
FAQ
How do I install OpenWiki globally?
Run `npm install -g openwiki` to install the CLI globally on your machine.
How do I initialize OpenWiki and configure my LLM provider?
Run `openwiki --init` (or start `openwiki` and follow prompts) to set the inference provider, API key, LLM, and optional LangSmith tracing; settings are saved to `~/.openwiki/.env`.
What are the ways to run OpenWiki (interactive, one-shot, with a prompt)?
Use `openwiki` for interactive mode, `openwiki "<request>"` to start with an initial request, or `openwiki -p "<prompt>"` / `openwiki --print "<prompt>"` for a one-shot non‑interactive run that prints the output.
How can I keep documentation up‑to‑date via CI?
Add the provided workflow files: copy `openwiki-update.yml` to `.github/workflows/` for GitHub Actions, or copy `openwiki-update.gitlab-ci.yml` to `.gitlab-ci.yml` (or include it) for GitLab CI to automatically open PRs/merge requests with doc updates.
How do I customize the inference provider, base URL, or model ID?
Set environment variables like `OPENWIKI_PROVIDER`, `OPENAI_COMPATIBLE_BASE_URL`, `ANTHROPIC_BASE_URL`, etc., or edit `~/.openwiki/.env`; you can also specify a custom model ID via `OPENWIKI_MODEL_ID` for any supported provider.
Where does OpenWiki store configuration and secrets?
Configuration options and API keys are saved locally in `~/.openwiki/.env` on your machine; the CLI also updates `AGENTS.md` and/or `CLAUDE.md` in the repo to point agents to the generated wiki.
Featured in Videos
YouTube tutorials and walkthroughs for openwiki
sd
80,246 views
Starts at 00:00
Alternatives
Similar projects ranked by category, topics, and text overlap.
