glowfish-cli

Generate customer-ready documentation from what actually happened in your repo — local-first, BYOK (bring your own provider key), and never a custodian of your code.

Glowfish reads your own git history (and, optionally, your captured agent sessions) on your machine, calls your LLM provider with your key, and writes readable docs. Your code is never uploaded to a Glowfish server and your provider key never leaves your machine.

Quick start

npx glowfish-cli onboard --key gf_… --runner cursor

That one command, run inside your own repo, does the whole setup:

• saves your Glowfish key (gf_…) locally,
• installs the Glowfish MCP server + the agent priming for your runner (claude or cursor),
• opens a local browser form to capture your AI provider key (which stays on your machine), and
• prints a clear "you're set up" check.

Add --no-browser to enter the provider key via a masked terminal prompt instead, and --repo <path> to target a repo other than the current directory.

Requires Node >= 22. You run Glowfish inside (or pointed at) your own repository — you never clone Glowfish itself.

Commands

| Command | What it does | | --- | --- | | onboard --key gf_… | One-shot setup: saves the key, installs capture + the MCP server + priming, opens the provider-key form, prints a setup check. --runner <claude\|cursor>, --repo <path>, --no-browser. | | setup | One-time: store your provider API key (BYOK), masked. | | key | Add your provider API key via a LOCAL browser form (or the masked terminal with --no-browser). The key stays on your machine. | | backfill | Reconstruct readable docs from a repo's git history. --dry-run previews cost/scope for FREE; --interview runs the in-process gap-map interview after. | | generate | Turn captured sessions + new commits into docs, incrementally. --dry-run previews the plan + cost for FREE. | | review | Open a LOCAL browser editor to review, edit, and publish the generated docs. Local-first — read/edit/save run on a loopback port and never leave your machine. --no-browser, --repo <path>. | | mcp <install\|uninstall\|serve> | Wire (or remove) the Glowfish MCP server, or run it. | | hooks <install\|uninstall\|status> | Wire (or remove) the Claude Code session reporter, or check whether Glowfish is working in this repo. |

Run npx glowfish-cli <command> --help for command-specific options.

Cost safety

Every paid-capable command has a free --dry-run that previews the dollar ballpark and the scope without making any paid LLM call. If no provider key resolves, a paid run fails loud and tells you to run glowfish setup — it never silently spends.

Privacy model

• Local-first — your repo is read and your docs are written on your machine.
• BYOK — you supply your own LLM provider key; it is stored locally and used directly against your provider.
• Never a custodian — Glowfish is not a custodian of your code or your provider key.