explaingit

langchain-ai/openwiki

Analysis updated 2026-07-03 · repo last pushed 2026-07-03

⭐ Rising1,759TypeScriptAudience · developerComplexity · 2/5ActiveSetup · easy

TLDR

OpenWiki automatically generates and updates code documentation so AI coding assistants always have accurate context about your project. It runs as a command-line tool and can auto-update docs daily via GitHub Actions.

Mindmap

mindmap
  root((repo))
    What it does
      Auto-writes code docs
      Updates docs on changes
      Appends context for AI agents
    Tech stack
      TypeScript
      OpenAI
      Anthropic
      LangSmith
    Use cases
      Keep docs in sync
      Help AI agents code
      Chat to guide docs
    Setup
      CLI init command
      Needs AI API key
      Optional GitHub Action
    Audience
      Developers
      Team leads
Click or tap to explore — scroll the page freely

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Automatically generate a wiki from your codebase so AI coding agents have up-to-date context.

USE CASE 2

Schedule daily documentation refreshes using a GitHub Action to keep docs synced with code changes.

USE CASE 3

Interactively chat with the tool to guide and refine how your project documentation is written.

USE CASE 4

Keep your AGENTS.md or CLAUDE.md files updated with instructions pointing AI assistants to your wiki.

What is it built with?

TypeScriptOpenAIAnthropicOpenRouterLangSmithGitHub Actions

How does it compare?

langchain-ai/openwikiinkeep/open-knowledgezarazhangrui/lark-coding-agent-bridge
Stars1,7591,8211,660
LanguageTypeScriptTypeScriptTypeScript
Last pushed2026-07-032026-07-022026-07-03
MaintenanceActiveActiveActive
Setup difficultyeasymoderatemoderate
Complexity2/52/52/5
Audiencedeveloperdeveloperdeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · easy Time to first run · 5min

Requires an API key from an AI provider like OpenAI or Anthropic, which you enter during the simple init command.

The license for this project is not specified in the available documentation.

In plain English

OpenWiki is a tool that automatically writes and updates documentation for your codebase, with a specific focus on helping AI coding agents understand your project. Instead of manually keeping your wiki or docs in sync with your latest code changes, you can run this command-line tool to do it for you. It generates documentation into an openwiki/ folder and can even automatically update those docs daily via a GitHub Action. To get started, you run a simple initialization command that prompts you to connect an AI provider (like OpenAI or Anthropic) and enter your API key. Once configured, the tool reads through your code and generates documentation. On subsequent runs, it checks what has changed in your repository and refreshes the existing documentation accordingly. You can use it interactively to chat and guide the documentation process, or run single commands for quick updates. The people who would benefit most from this are developers and team leads who use AI assistants to write or review code. AI agents need context to work effectively, and outdated documentation can lead to bad suggestions. OpenWiki helps solve this by automatically appending instructions to your AGENTS.md or CLAUDE.md files, telling your coding agent to reference the generated wiki for context. This ensures your AI tools always have accurate, up-to-date information about how your codebase works. The project is built in TypeScript and supports several major AI providers right out of the box, including OpenRouter, Fireworks, Baseten, OpenAI, and Anthropic. While it offers a few pre-defined models to choose from, it also gives you the flexibility to specify a custom model ID for your preferred provider. Configuration and API keys are stored locally on your machine in a hidden file, and you can optionally connect it to LangSmith to trace and monitor your documentation generation runs.

Copy-paste prompts

Prompt 1
I have OpenWiki installed. Write a GitHub Actions workflow YAML file that runs the OpenWiki update command every day at midnight and commits the changes to the openwiki/ folder.
Prompt 2
Help me choose between OpenAI and Anthropic for OpenWiki by comparing the cost and quality of generating documentation for a TypeScript project with about 50 files.
Prompt 3
I ran `openwiki init` and selected OpenAI but I keep getting an authentication error. Walk me through how to debug the API key setup and verify the key is stored correctly.
Prompt 4
Show me how to configure OpenWiki to use a custom model ID on OpenRouter instead of the pre-defined models listed during initialization.

Frequently asked questions

What is openwiki?

OpenWiki automatically generates and updates code documentation so AI coding assistants always have accurate context about your project. It runs as a command-line tool and can auto-update docs daily via GitHub Actions.

What language is openwiki written in?

Mainly TypeScript. The stack also includes TypeScript, OpenAI, Anthropic.

Is openwiki actively maintained?

Active — commit in last 30 days (last push 2026-07-03).

What license does openwiki use?

The license for this project is not specified in the available documentation.

How hard is openwiki to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is openwiki for?

Mainly developer.

Open on GitHub → Explain another repo

This repo across BitVibe Labs

Scan in gitsafehub Deploy in gitdeployhub langchain-ai on gitmyhub

Verify against the repo before relying on details.