Guide

Get a live wiki from your repo in five minutes.

Install

wikipilot is an MIT-licensed CLI published to npm.

$ npm install -g wikipilot

Not showing up yet? The package is mid-launch — if the npm install above 404s, build from source instead:

$ git clone https://github.com/guymoyal/wikipilot $ cd wikipilot && npm install && npm run build $ npm link # now the wikipilot command runs from ./dist

Initialize

Run this from the root of the repo you want documented. It drafts a dev/product/user portal wiki from your actual repo content — no blank templates to fill in.

$ wikipilot init
  • -o, --out <dir> — where to scaffold the wiki (default ./wiki)
  • --no-skill — skip scaffolding the Claude Code sync skill

Build & serve

Turn the Markdown wiki into a static site, then preview it locally.

$ wikipilot build --out ./wiki-dist --site-name "My Project" $ wikipilot serve --port 4400

The output is plain HTML/CSS/JS — search, theme toggle, and Mermaid diagrams all work with zero server-side code, so you can host it anywhere.

Ask-the-wiki assistant

Run a small local API that grounds a chat widget in your wiki's own content only.

$ export ANTHROPIC_API_KEY=sk-... $ wikipilot agent --port 4402

Point --agent-port at this when you run wikipilot build and the built site's chat widget will use it automatically.

Deploy

Today: host the wiki-dist/ output anywhere that serves static files — GitHub Pages, S3, your own nginx box. Soon: skip that step entirely.

# coming with Pro — not live yet $ wikipilot login $ wikipilot deploy

Join the hosted-wiki waitlist →

Next steps

  • Star the repo and skim the source — it's a plain TypeScript CLI, nothing exotic.
  • Open an issue if a command behaves differently than this guide says — that's a bug in one of us.
  • Wire wikipilot init's scaffolded skill into your normal workflow so the wiki stays synced without a separate chore.

View source on GitHub