Docs / Get started
Quickstart
Install Prism, ask your agent for a change, and read the verdict.
Your agent starts in the right files and every change gets a verdict.
Needs: Node.js, a git repository, and a coding agent.
1. Install and connect your agent
npm install -g @prismapp/cli
cd your-repo
prism install allThe first command puts Prism on this machine. prism install all connects
every agent it finds. Quit the agent and open it again. The first use in this
repository builds the index under ~/.prism/.
One agent only: prism install cursor (or claude, codex, opencode). Add
--project to write that agent’s files into this repository. prism start
does the connect step and also prints a map of the repo. To add the MCP server
by hand, see Install.
prism doctor shows which directory Prism treats as the workspace, your
strength setting, and what is installed for each agent.
2. Ask your agent for a change
Open your agent in the repository and ask in plain words. You never type tool names.
Agent
You: Add VAT to invoice totals.
Agent: Starting in invoice.ts and totals.ts, then running their tests.Terminal (the same file list, without an agent; shortened)
prism prepare "add VAT to invoice totals"Prepare: add VAT to invoice totals
…
PATH WHY
src/billing/invoice.ts matches invoice, total; seed file
src/billing/totals.ts matches total; import distance 1
src/checkout/summary.ts import distance 1
…Before it edits, your agent gets the few files that matter, what to reuse and the house style. Paths only, never file bodies.
3. Read the verdict
When the session ends, Prism runs the checks that reach the change and gives a verdict: SHIP, NOT PROVEN or NO-SHIP. It comes back in the agent's reply. A check that was already failing is reported on its own line and does not block. See Install.
Receipts are kept. List them, or show the newest:
prism receipts
prism receipts show 1What each line means: Receipt.
Explore from the terminal
The same answers your agent uses, without an agent:
| Command | Answers |
|---|---|
prism overview | What this project is: frameworks, domains, landmarks to read first |
prism blast src/some/file.ts | What a change to this file would break |
prism explain src/some/directory | What belongs together |
prism prepare "<task>" | Which files to read before a change |
Every command and flag: CLI reference.
Next
| You want | Go to |
|---|---|
| Task recipes | Guides |
| Prepare / Guard | Prepare · Guard |
| Every command | CLI reference |
| Something looks wrong | Troubleshooting |