Free forever. Hosted when you want it.
The CLI is open source and free — always. Pro and Team add hosting and cross-repo visibility on top.
Free
The open-source CLI, self-hosted.
- Full wikipilot CLI (generate, build, serve)
- Freshness contract on every page
- Full-text search & Mermaid diagrams
- Ask-the-wiki AI assistant (bring your own API key)
- Host the output anywhere you like
Pro
Skip the hosting. Skip the API key too.
- Everything in Free
- Hosted wiki at <project>.wikipilot.dev
- AI assistant included — no API key to set up or pay for separately
- One command deploy, no server to run
- Automatic HTTPS & CDN
- Priority support
Team
For teams tracking more than one repo.
- Everything in Pro
- Cross-repo wiki dashboard
- Staleness alerts to Slack & GitHub
- Org-wide search
- Seats for the whole team
Questions people actually ask
Wiki Pilot is an open-source command-line tool that scans a code repository and generates a browsable documentation wiki from it. Each page records which source files it was built from, so pages that have fallen behind the code can be identified instead of guessed at. Install it with npm install -g wikipilot.
Documentation drift is the gap that opens between what a page says and what the code does, because the code kept changing and the page didn't. It's ordinary and unavoidable; the problem is that it's invisible. A page that went wrong in March looks exactly like one confirmed correct last week. Wiki Pilot makes the gap measurable by having each page declare the paths it covers and the commit it was last verified at — so "which pages did this refactor invalidate?" becomes a git diff rather than a memory exercise.
Docusaurus, GitBook, Notion-as-docs — they all render nicely, and then nobody touches the content again. Wiki Pilot's difference is unglamorous: it records which source files a page came from and which commit it was verified at. Change those files without updating the page and the page says so, rather than sitting there looking finished.
From the repository root, run npx wikipilot init. It reads the code and drafts a documentation wiki with getting-started, how-it-works, onboarding, reference and FAQ pages, without an API key. Add --ai (or --ai --engine claude-code on a Claude plan) and an AI agent reads the source and rewrites every page from what it finds. Then wikipilot build turns the wiki into a static docs site you can host anywhere.
Yes. Running wikipilot init asks which kind of wiki you want — technical, user guide, or both — and drafts sections to match. A user guide gets Getting Started, Guides, FAQ, and Troubleshooting; a technical wiki gets Onboarding, How It Works, Technologies, Reference, and Cookbook. Pass --preset technical, --preset user-guide, or --preset all to skip the question.
That's what the onboarding section is for — the page a new teammate reads before their first commit: how to get the project running, how the repo is laid out, where to start editing. The technical and default presets both include it. Without an API key you get a stub with the detectable parts filled in; the deep-investigation pass writes the full version.
No. Drafting, building, and serving a wiki run entirely on your machine. An API key unlocks two optional extras. The first is a deep-investigation pass during init, where an AI agent reads your code and rewrites the draft from what it finds — Claude by default, or OpenAI, Gemini, and other OpenAI-compatible endpoints via --provider. If you use Claude Code, --engine claude-code runs that pass through it instead, on your Pro or Max plan, with no key at all. The second extra is the ask-the-wiki assistant on the built site, which is Claude-only and wants ANTHROPIC_API_KEY specifically.
For the deep investigation, yes. A Claude subscription and Anthropic API credits are billed separately, so an API key on a new account often has no balance even when you pay for Max. Run wikipilot init --ai --engine claude-code with Claude Code installed and signed in, and the investigation runs inside Claude Code, counting against your plan's usage. wikipilot hides any ANTHROPIC_API_KEY from that run, because Claude Code would otherwise bill the key. The ask-the-wiki assistant is the one feature that still needs an API key.
Not unless you switch on one of the two optional AI features. wikipilot init, build, and serve read your repository and write files locally — there is no Wiki Pilot account, server, or telemetry involved at any point. If you do run the deep-investigation pass, the files the agent chooses to read go to whichever provider you picked, under your own key: Anthropic by default, OpenAI or Gemini if you chose them with --provider, or whatever endpoint you named with --provider custom. With --engine claude-code they go to Anthropic through your own Claude Code sign-in. Screenshots are taken by a browser on your machine, and only of the sites you listed. The ask-the-wiki assistant runs as a process you start yourself and talks only to Anthropic. Skip all of it and nothing leaves the machine.
It depends on the repo. The default is Claude Opus 5.5 at high effort, billed to your own Anthropic key: expect a few dollars for a mid-size repository and more for a large monorepo. The run is bounded however big the repo is — at most 200 model turns and a fixed read budget (3 MB of file content on 1M-context models) — and the conversation is prompt-cached, so re-reading history each turn costs about a tenth of the normal input rate. It prints the token count and an estimated cost at the end. --model claude-sonnet-5-5 costs about half as much per token, and --effort medium trims the thinking. On a Claude Pro or Max plan, --engine claude-code bills nothing extra; the run counts against your plan's usage instead.
Yes: write a wikipilot.md at the repo root. It's plain Markdown saying who the readers are, which journeys and pages matter, and where the relevant code lives. Optional frontmatter sets the sections (replacing the preset's list), the site name, and the sites the agent may screenshot. The agent reads the brief first and treats its facts as leads: each one is checked against the code, and where the two disagree the page follows the code and the run summary names the mismatch.
Yes. List the sites with --screenshots or under screenshots: in wikipilot.md, and the agent captures the pages it documents with Playwright, looked up in your repo first. It can only load pages, so it never clicks, types, or signs in. For screens a browser can't reach, it copies images already in the repo, such as your test runs' screenshots. You can do the same by hand with wikipilot screenshot and wikipilot image.
wikipilot build outputs plain static HTML, CSS, and JavaScript into a directory. Host that on GitHub Pages, Cloudflare Pages, S3, or any web server — there is no backend to run. The optional AI assistant is the one part that needs a server, and you point the built site at it with --agent-url.
Yes. Wiki Pilot reads the repository's file structure, README, and package manifest rather than parsing one language's syntax, so it isn't tied to a particular stack.
It's built for it. The wiki-type prompt only appears on an interactive terminal — a piped or non-TTY run takes the default preset instead of hanging — and --yes or --preset makes the choice explicit in a script. The usual pipeline is to commit the wiki/ folder like any other source, run wikipilot build on push, and publish the output directory. The deep-investigation pass is opt-in there too: it runs in CI only when you pass --ai with the chosen provider's key already in the environment, because it won't prompt for a key it can't ask for.
Yes, MIT licensed, and it stays that way. The source is on GitHub and the package is published on npm. Only the hosted Pro and Team tiers are a paid product.
wikipilot init also writes a Claude Code skill into your repo. Asking Claude Code to update the wiki makes it diff each page's declared sources since that page's last verified commit, re-read the files that changed, and rewrite the affected prose. Pages it can't confidently update are marked as needing review instead of being rewritten on a guess.