OpenWiki

A LangChain-built CLI that writes and maintains codebase documentation automatically — generates an initial wiki, refreshes it as the repo changes, and can open a daily PR of documentation updates via GitHub Actions.

3.5Kstars
278forks
MIT License
TypeScript

OpenWiki treats documentation as something an AI agent should maintain continuously rather than something written once and left to rot. Running openwiki --init generates initial documentation into an openwiki/ directory in your repo; running it again on an existing openwiki/ refreshes that documentation based on what’s changed in the codebase since.

A provided GitHub Actions workflow (openwiki-update.yml) automates this: it opens a pull request once a day with documentation updates, so keeping docs current doesn’t depend on someone remembering to run the CLI manually. The tool supports both interactive sessions (stays open for follow-up requests) and one-shot non-interactive runs (-p/--print) for scripting and CI use.

MIT licensed and built by the LangChain team, OpenWiki is distributed as a global npm package (npm install -g openwiki) and requires your own model API key rather than depending on a hosted LangChain service.

What You Get

  • A CLI that generates initial documentation for a codebase into an openwiki/ directory
  • Automatic refresh of existing documentation based on repository changes since the last update
  • A GitHub Actions workflow template for opening a daily PR with documentation updates
  • Both interactive CLI sessions and one-shot, scriptable non-interactive runs

Common Use Cases

  • Bootstrapping documentation for an undocumented codebase without writing it all by hand
  • Keeping existing documentation continuously up to date as a codebase evolves, via a daily automated PR
  • Generating documentation as part of a CI pipeline using the non-interactive -p flag
  • Giving an AI agent an interactive session to answer questions about generating or updating documentation for a repo

Under The Hood

Architecture OpenWiki’s core behavior branches on whether an openwiki/ directory already exists in the target repo: absent, it generates fresh documentation from scratch; present, it refreshes based on what changed, avoiding a full regeneration each time. The provided GitHub Actions workflow wraps the CLI’s update mode into a scheduled job that opens a PR rather than committing directly, keeping documentation changes reviewable like any other code change.

Tech Stack TypeScript/Node.js, distributed as a global npm package (openwiki), requiring a user-supplied model provider API key. GitHub Actions integration is provided as a template workflow file rather than a separate hosted service.

Code Quality Very active development reflects ongoing iteration on a young project; being built and maintained by the LangChain team lends it credibility given their broader track record in the LLM tooling space, though project maturity signals (long-term stability, extensive community usage) are still developing.

What Makes It Unique Most AI documentation generators produce a one-time snapshot; OpenWiki’s update mode plus a ready-made daily-PR GitHub Action specifically targets documentation staying current over a repo’s lifetime, treating docs as a continuously maintained artifact rather than a point-in-time generation task.

Self-Hosting

Licensing Model MIT licensed — fully open source with no license key.

Self-Hosting Restrictions Not applicable; it’s a local CLI requiring your own model provider API key, with no hosted backend.

License Key Required No.

Join founders buildingwith open source

Opinionated takes, migration guides, cost-saving tips, and insights from the open source ecosystem.

Subscribe on Substack

No spam. Unsubscribe anytime.

Join 750+ subscribers
No spam. Unsubscribe anytime.

Search