# OpenWiki

> A CLI tool that writes and maintains agent-optimized documentation for your codebase, built by LangChain AI.

OpenWiki is an open-source CLI tool built by LangChain AI that automatically generates and maintains documentation for software codebases, with a specific focus on making that documentation useful for AI coding agents. It is written in TypeScript, licensed under MIT, and installable globally via npm.

## What It Is

OpenWiki sits in the category of AI-assisted documentation tools, but with a distinct twist: rather than producing docs for human readers alone, it is designed to produce documentation that coding agents (like those using `AGENTS.md` or `CLAUDE.md` conventions) can reference for context. The tool runs as an interactive CLI, analyzes your repository, and writes structured documentation into an `openwiki/` directory. It can also refresh that documentation as the codebase evolves.

## How It Works

The workflow centers on three core commands:

- `openwiki --init` — configures your inference provider, API key, and LLM on first run, saving settings to `~/.openwiki/.env`
- `openwiki` — starts an interactive session; generates docs if none exist, or refreshes them if `openwiki/` already exists
- `openwiki --update` — explicitly refreshes existing documentation from repository changes

OpenWiki automatically appends prompting instructions to `AGENTS.md` and/or `CLAUDE.md` files in your repository, creating them if they don't exist, so that coding agents know to reference the generated wiki for context.

## Keeping Docs Up to Date

A key feature is the provided GitHub Actions workflow (`openwiki-update.yml`) that can be added to any repository. Once configured, it runs daily and automatically opens a pull request with documentation updates, keeping the wiki in sync with code changes without manual intervention.

## Model and Provider Support

OpenWiki supports multiple inference providers out of the box: OpenRouter, Fireworks, Baseten, OpenAI, and Anthropic. Several models are pre-configured (including GLM 5.2, Kimi K2.6, and Sonnet 5), but users can specify a custom model ID for any supported provider. LangSmith tracing integration is also available optionally, routing OpenWiki runs to a dedicated "openwiki" tracing project.

## Current Status

The repository was created in late June 2026 and last updated in early July 2026, with 3,050 stars and 240 forks reported on GitHub at that time — a strong early adoption signal for a newly launched project. It has 68 open issues, indicating active community engagement. The project is under active development by the LangChain AI organization.

## Features
- Interactive CLI for generating and updating codebase documentation
- Agent-optimized documentation output targeting AGENTS.md and CLAUDE.md
- Automatic daily documentation updates via GitHub Actions workflow
- Support for OpenRouter, Fireworks, Baseten, OpenAI, and Anthropic inference providers
- Custom model ID support for each inference provider
- LangSmith tracing integration for observability
- One-shot non-interactive mode with -p/--print flag
- Configuration stored locally in ~/.openwiki/.env
- Automatic creation of AGENTS.md and CLAUDE.md if not present

## Integrations
OpenRouter, Fireworks, Baseten, OpenAI, Anthropic, LangSmith, GitHub Actions

## Platforms
API, CLI

## Pricing
Open Source

## Links
- Website: https://github.com/langchain-ai/openwiki
- Documentation: https://github.com/langchain-ai/openwiki#readme
- Repository: https://github.com/langchain-ai/openwiki
- EveryDev.ai: https://www.everydev.ai/tools/openwiki