Docs / Reference
CLI commands
Every Prism CLI subcommand, generated from the command table the binary is built from.
Every prism command, generated from the command table the binary is built
from. If a command appears here, it exists; if its options are listed here,
they are the options it accepts.
See Usage for global options, exit codes, and how
--fail-on behaves in CI.
Set up
prism start
Install Prism for every coding agent found here, index this repo and show its map
prism startprism install <client>
Connect Prism to Claude Code, Cursor, Codex or opencode (MCP server, hooks, skills, rule line)
| Argument | Meaning |
|---|---|
<client> | claude, cursor, codex, opencode, or all |
| Option | Meaning |
|---|---|
--project | Write the configs into this repository |
--user | Write the configs into your home (default) |
--local <checkout> | Built Prism checkout to link (default: the one this CLI runs from) |
prism install claudeprism install cursor --projectprism install all --local ~/Prismprism uninstall
Remove everything prism install added; --purge also deletes Prism data
| Option | Meaning |
|---|---|
--purge | Also delete ~/.prism and this repository's .prism |
prism uninstallprism uninstall --purgeprism upgrade
Re-link the recorded clients to the current build and restart the daemon
prism upgradeUnderstand a repository
prism overview
What this repository is: DNA, stack and landmarks
| Option | Meaning |
|---|---|
--limit <n> | Maximum rows to print (default 50) |
prism overview --json | jq '.data.dna.frameworks'prism explain <path>
What a file or folder is for, and who owns it
| Argument | Meaning |
|---|---|
<path> | File or folder to explain |
prism explain src/serverprism explore <target>
Usages, ownership and similar code for a file or symbol
| Argument | Meaning |
|---|---|
<target> | File path, or symbol with --symbol |
| Option | Meaning |
|---|---|
--symbol | Treat the argument as a symbol name rather than a file path |
--in <path> | File to look in, when several symbols share a name |
--limit <n> | Maximum rows to print (default 50) |
prism explore src/index.tsprism packages
Every package in the workspace and where it lives
| Option | Meaning |
|---|---|
--limit <n> | Maximum rows to print (default 50) |
prism packagesprism agents-md <action>
Generate or verify the Living AGENTS.md (never written to the repo)
| Argument | Meaning |
|---|---|
<action> | generate or check |
prism agents-md generateprism agents-md checkprism findings <action> [fingerprint]
Unused exports, duplicate implementations, wrapper functions
| Argument | Meaning |
|---|---|
<action> | list, mute, or unmute |
[fingerprint] | Required for mute/unmute — a finding's fingerprint field |
| Option | Meaning |
|---|---|
--all | list: include findings already muted |
prism findings listprism findings mute a3f8c5f0c392dbebAssess a change
prism prepare <task...>
Files, reuse, and House Style for a task — never file bodies
| Argument | Meaning |
|---|---|
<task...> | What you are about to change, in plain language |
| Option | Meaning |
|---|---|
--budget <n> | Token budget for the whole answer (default 2000, max 6000) |
prism prepare --json "add caching to fetchUser"prism blast <target>
What breaks if this file or symbol changes
| Argument | Meaning |
|---|---|
<target> | File path, or symbol with --symbol |
| Option | Meaning |
|---|---|
--symbol | Treat the argument as a symbol name rather than a file path |
--in <path> | File to look in, when several symbols share a name |
--delete | Assess a deletion rather than an edit |
--fail-on <band> | Exit 1 when the risk is at or above this band: low, mid, high |
--limit <n> | Maximum rows to print (default 50) |
prism blast src/core/index.ts --fail-on highprism review [paths...]
Risk of the current changes, or of the paths you name
| Argument | Meaning |
|---|---|
[paths...] | Files to review (default: the working-tree diff) |
| Option | Meaning |
|---|---|
--base <rev> | Diff against a git revision |
--lens <name> | Also run this lens's data-backed checks (architect, dev, qa, or a custom lens) |
--fail-on <band> | Exit 1 when the risk is at or above this band: low, mid, high |
--limit <n> | Maximum rows to print (default 50) |
--format <fmt> | Machine output format: sarif (GitHub code scanning) |
prism review --lens qaprism review --base origin/main --fail-on highprism review --base origin/main --format sarifprism safe-delete <target>
Whether a file or symbol can be removed
| Argument | Meaning |
|---|---|
<target> | File path, or symbol with --symbol |
| Option | Meaning |
|---|---|
--symbol | Treat the argument as a symbol name rather than a file path |
--in <path> | File to look in, when several symbols share a name |
--limit <n> | Maximum rows to print (default 50) |
prism safe-delete src/legacy/old.tsprism rename <target> [newName]
Every edit site a rename would touch
| Argument | Meaning |
|---|---|
<target> | File path, or symbol with --symbol |
[newName] | Proposed new name |
| Option | Meaning |
|---|---|
--symbol | Treat the argument as a symbol name rather than a file path |
--in <path> | File to look in, when several symbols share a name |
--limit <n> | Maximum rows to print (default 50) |
prism rename src/util.ts src/helpers.tsprism test-impact <target>
Tests that a change can reach
| Argument | Meaning |
|---|---|
<target> | File path, or symbol with --symbol |
| Option | Meaning |
|---|---|
--symbol | Treat the argument as a symbol name rather than a file path |
--in <path> | File to look in, when several symbols share a name |
--fail-on <count> | Exit 1 at this many findings, or 'any' for one or more |
--limit <n> | Maximum rows to print (default 50) |
prism test-impact src/core/index.tsprism receipts [action] [n]
List the change receipts the stop hook wrote, or show one
| Argument | Meaning |
|---|---|
[action] | list (default) or show |
[n] | show: which receipt, 1 is the newest |
| Option | Meaning |
|---|---|
--as <format> | show: text, markdown, or svg |
--last | Show the newest receipt |
--limit <n> | Maximum rows to print (default 50) |
prism receiptsprism receipts --lastprism receipts show 1 --as markdown > receipt.mdprism lens [action] [target]
List, show, add or remove review lenses (shared by every repository), or overrule a lens check
| Argument | Meaning |
|---|---|
[action] | list (default), show, add, remove, or override |
[target] | add: the lens name; show/remove/override: the lens id |
| Option | Meaning |
|---|---|
--name <text> | add: display name (default: the id) |
--role <text> | add: what the lens is |
--focus <text> | add: how it judges |
--checklist <item> | add: a checklist item (repeatable) |
--checks <ids> | add: data-backed checks, comma-separated (repeatable) |
--evidence <ids> | add: Prism reads it uses, comma-separated (repeatable) |
--trigger <phrase> | add: a phrase that chooses this lens (repeatable) |
--check <id> | override: the check to overrule |
--path <file> | override: the file the finding names |
--note <text> | override: why it is fine |
prism lens show devprism lens add perf --role "Checks hot paths" --focus "No new N+1" --checklist "No query in a loop" --trigger "slow query"prism lens override dev --check reuse_missed --path src/utils/formatDueDate.ts --note "intentionally differs"Inspect structure
prism deps
Dependency graph size and its most connected nodes
| Option | Meaning |
|---|---|
--packages | Aggregate files into packages |
--limit <n> | Maximum rows to print (default 50) |
prism deps --packagesprism cycles
Import and re-export cycles
| Option | Meaning |
|---|---|
--packages | Aggregate files into packages |
--fail-on <count> | Exit 1 at this many findings, or 'any' for one or more |
--limit <n> | Maximum rows to print (default 50) |
--format <fmt> | Machine output format: sarif (GitHub code scanning) |
prism cycles --fail-on anyprism cycles --format sarifprism symbol <name>
Find where a symbol is declared
| Argument | Meaning |
|---|---|
<name> | Symbol name |
| Option | Meaning |
|---|---|
--in <path> | File to look in, when several symbols share a name |
--kind <kind> | Filter by kind, e.g. function |
--limit <n> | Maximum rows to print (default 50) |
prism symbol createWorkspaceprism refs <name>
Find who references a symbol
| Argument | Meaning |
|---|---|
<name> | Symbol name |
| Option | Meaning |
|---|---|
--in <path> | File to look in, when several symbols share a name |
--limit <n> | Maximum rows to print (default 50) |
prism refs riskToBandprism route <from> <to>
How one file reaches another through dependencies
| Argument | Meaning |
|---|---|
<from> | Starting file |
<to> | Destination file |
| Option | Meaning |
|---|---|
--alternatives <n> | How many distinct routes to return |
prism route src/cli.ts src/output.tsMemory
prism habit [action] [name]
Save routines (e.g. "start my day") that any agent can run through the habits tool
| Argument | Meaning |
|---|---|
[action] | list (default), add, show, edit, or remove |
[name] | The habit name (quote it) |
| Option | Meaning |
|---|---|
--step <text> | add: "source: action [| filter]" (repeatable, in order) |
--output <format> | add: standup, summary, checklist, table, or free |
--template <text> | add: how to lay out the result |
--description <text> | add: one line about the habit |
prism habit add "start my day" --step "github: list my open PRs and review requests" --step "linear: my in-progress issues" --step "notion: read Daily notes for today" --output standupprism habit show "start my day"prism remember <note...>
Save a note about this repository for Prepare to hand back
| Argument | Meaning |
|---|---|
<note...> | The note, in plain language |
| Option | Meaning |
|---|---|
--symbol <name> | Anchor the note to a symbol |
--path <path> | Anchor the note to a path |
prism remember "use lruCache, never a bare Map" --symbol lruCacheprism forget <id-or-text...>
Forget memories by id or by matching text
| Argument | Meaning |
|---|---|
<id-or-text...> | A memory id or part of its text |
prism forget 3f9a2c1b7e04prism forget lruCacheprism memories
List the notes saved for this repository
prism memoriesprism memories --jsonDiagnostics
prism doctor [topic]
Check the environment, workspace and index
| Argument | Meaning |
|---|---|
[topic] | skills: check user skills that name Prism tools |
| Option | Meaning |
|---|---|
--ci | Extra CI checks (e.g. warn on shallow clones that truncate history) |
--surfaces | Show which Prism each editor launches. Fails inside this repo if any of them is the published package. |
--fix | Stop the daemon, rewrite editor configs to the recorded local build or the installed server, and update hook configs an older release wrote |
prism doctorprism doctor --ciprism doctor --surfacesprism doctor skillsprism doctor --fixprism strength [level]
How much the hooks do: full (default), lite (rules and the stop receipt) or off
| Argument | Meaning |
|---|---|
[level] | full, lite or off; omit to show the strength in effect |
| Option | Meaning |
|---|---|
--repo | Set it for this repository only (.prism/config.json) |
prism strengthprism strength liteprism strength off --repoprism stats
Hook and tool timings and outcomes from events.jsonl
| Option | Meaning |
|---|---|
--since <duration> | Only events newer than this, e.g. 1d, 6h (default: all) |
prism statsprism stats --since 1dprism data prune
Prune Prism's local library (dry run unless --yes)
| Argument | Meaning |
|---|---|
prune | List empty workspace folders, caches of deleted checkouts, and untracked worktrees |
prism data pruneprism data prune --yesprism index
Build or refresh the repository index
prism indexprism graph [action]
The background daemon that keeps the graph fresh
| Argument | Meaning |
|---|---|
[action] | status (default), serve, stop, refresh, map, or export |
| Option | Meaning |
|---|---|
--out <dir> | export: where to write graph.json |
--scope <path> | map: only files under this path |
--budget <tokens> | map: token budget for the map |
--refresh | map: rebuild instead of reading the cache |
prism graphprism graph serveprism graph map --budget 800prism graph export --out .prism/graphprism completions <shell>
Print shell completion script (bash, zsh, or fish)
| Argument | Meaning |
|---|---|
<shell> | Shell to generate for: bash, zsh, or fish |
prism completions bash >> ~/.bashrcprism completions zsh > ~/.zfunc/_prism