litewiki

A local-first CLI that generates a wiki-style report for your codebase.

中文 README

Features

• Interactive CLI: wiki opens a simple menu (run, report, profile, config).
• Project archiving: generated reports are saved under your user config directory.
• Incremental mode: can reuse the latest archived report as input.
• Tool-using agent: the agent explores your repo via tools (listDirectory, readFile, renderMermaid).

Install

Requirements:

• Node.js (ESM)
• pnpm (recommended)

Install globally:

npm i -g litewiki
# or
pnpm add -g litewiki

Then run:

wiki

Development Install

pnpm install
pnpm build

Then run the CLI:

pnpm -s build
node dist/index.js

Or link it locally (optional):

pnpm link --global
wiki

Quick Start

1. Create an AI config:

wiki config

You will be asked for:

• provider: openai | anthropic | google | custom (only openai works for now)
• model
• baseUrl
• key

2. Run:

wiki run .

Providers

We intentionally flatten providers to:

provider: "openai" | "anthropic" | "google" | "custom"

• Supported: openai
• Not supported yet (but selectable in UI): anthropic, google, custom

See: docs/providers.md

Commands

• wiki: interactive menu
• wiki run [dir]: analyze a directory
• wiki profiles: manage prompt profiles
• wiki reports: view/delete archived reports
• wiki config: manage AI configs

Development

pnpm test
pnpm lint
pnpm format
pnpm build
pnpm dev

Agent Guide

If you're using a coding agent (Cursor/Copilot/etc.), see: AGENTS.md

License

ISC © Carbon