whatisgithub

What is pi-openwiki?

barvhaim/pi-openwiki — explained in plain English

Analysis updated 2026-05-18

9TypeScriptAudience · developerComplexity · 2/5LicenseSetup · easy

In one sentence

A Pi AI agent extension that automatically generates and keeps codebase documentation up to date.

Mindmap

mindmap
  root((pi-openwiki))
    What it does
      Auto generate docs
      Git aware updates
      Chat with codebase
    Tech stack
      Pi agent
      TypeScript
      Node.js
    Use cases
      Generate architecture docs
      Update after code changes
      Ask codebase questions
    Audience
      Pi agent developers

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 structured documentation for a codebase using an AI agent.

USE CASE 2

Keep existing documentation current by updating only the parts affected by recent git changes.

USE CASE 3

Ask natural language questions about how a codebase works without editing any files.

What is it built with?

TypeScriptNode.jsPiGit

How does it compare?

barvhaim/pi-openwikideskulpt/adk-okf-grounded-chatmaximseshuk/payload-plugin-openapi
Stars999
LanguageTypeScriptTypeScriptTypeScript
Setup difficultyeasymoderateeasy
Complexity2/54/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 the Pi agent (0.80+), a git repository, and Node.js with TypeScript.

MIT licensed, free to use for any purpose including commercial use, as long as the copyright notice is kept.

So what is it?

pi-openwiki is an extension for Pi, an AI coding agent, that automatically writes and keeps documentation for your codebase up to date. It is based on an earlier project called OpenWiki, built by LangChain, and has been adapted to work specifically inside the Pi agent ecosystem. The idea is simple: instead of writing documentation by hand and letting it go stale as code changes, you point this tool at your project and it generates a structured set of markdown files covering things like a quickstart guide, system architecture, development workflows, business logic, deployment steps, and testing strategy. After the first run, you can ask it to update just the parts of the documentation affected by recent code changes, since it tracks git history to know what has changed since the last update. There is also a chat command that lets you ask plain-language questions about how your codebase works without changing any files. To use it, you need Pi itself (version 0.80 or newer), a project stored in a git repository, and Node.js with TypeScript installed. Installation happens through Pi's own package manager, either globally, for a single project, directly from GitHub, or temporarily for one session. Internally, the tool works in five steps: it explores your repository and git history, tries to understand the reasoning behind the code, generates the markdown documentation, saves metadata so future updates are efficient, and can automatically update related agent instruction files. This is aimed at developers who already use the Pi coding agent and want their project's documentation, and the context available to AI coding assistants, to stay accurate without manual upkeep. It is not a general documentation generator for use outside the Pi ecosystem.

Copy-paste prompts

Prompt 1
Show me how to install pi-openwiki and run /openwiki:init on my project.
Prompt 2
Help me set up pi-openwiki so it updates docs automatically after I commit code changes.
Prompt 3
Explain how pi-openwiki decides what to regenerate versus what to leave unchanged.
Prompt 4
Walk me through using /openwiki:chat to ask how authentication works in my codebase.

Frequently asked questions

What is pi-openwiki?

A Pi AI agent extension that automatically generates and keeps codebase documentation up to date.

What language is pi-openwiki written in?

Mainly TypeScript. The stack also includes TypeScript, Node.js, Pi.

What license does pi-openwiki use?

MIT licensed, free to use for any purpose including commercial use, as long as the copyright notice is kept.

How hard is pi-openwiki to set up?

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

Who is pi-openwiki for?

Mainly developer.

Open on GitHub → Ask about another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.