# Copybook

> Define the code snippets and agent prompts in your product as typed, tested, versioned content.

Start here: https://copybook.dev/index.md explains what Copybook is, how to set it up, and the prompt to give a coding agent.

Every page in one file: https://copybook.dev/llms-full.txt

Read, list, and search these docs over MCP: https://copybook.dev/mcp

## Coding agents

`copybook init` sets up coding agents: an `AGENTS.md` section, the Copybook skill, and the `copybook` MCP server in `.mcp.json` (`npx --no copybook mcp`, with tools status, find_definitions, get_definition, render, check, write_snapshots, prune_snapshots, run_tests). Guide: https://copybook.dev/docs/guides/agents.md

## CLI commands

- `copybook init [options]` (ask first): Set up Copybook: write copybook.config.ts, install the packages, and set up coding agents. Safe to run again. It changes only what's out of date: copybook.config.ts, an AGENTS.md section, the Copybook skill, MCP configs, a .gitignore entry, and missing packages. --dry-run shows what would change.
- `copybook status [options]` (agents can run it): Show the project's definitions, snapshots, issues, and latest results, and what to do next.
- `copybook list [options]` (agents can run it): List every definition, with its kind and placements.
- `copybook show [options] <id>` (agents can run it): Show one definition: where it's shown, its params, its rendered output, tests, and history.
- `copybook snapshot [options]` (agents can run it): Write a rendered snapshot of every definition. --prune deletes snapshot files; ask before using it.
- `copybook check [options]` (agents can run it): Validate definitions and fail if any snapshot is missing, stale, or orphaned.
- `copybook test [options]` (agents can run it): Check that commands and snippets parse, typecheck, and run. The syntax and typecheck tiers are safe. The run tier executes commands for real, with fixtures; ask before running it.
- `copybook eval [options]` (CI only): Give prompts to coding agents and check what they did. Agents run with their permission prompts bypassed, in a directory that isn't isolated. It refuses to run unless CI=true or --unsafe-local is set.
- `copybook usages [options]` (agents can run it): Show which product files import each definition.
- `copybook report [options]` (agents can run it): Print a Markdown summary of changed definitions, for pull request comments.
- `copybook studio [options]` (ask first): Browse, preview, and trace every definition in a local UI. It keeps running. With --json it prints its URLs as one line once it's listening; its API is described at /llms.txt.
- `copybook mcp [options]` (agents can run it): Serve this project to coding agents over MCP, on stdio. Your agent's MCP client starts it. Your agent's MCP client starts it over stdio. Its tools read, render, check, write snapshots, and run the safe tests; evals and the run tier stay in the CLI.
- `copybook commands [options]` (agents can run it): List every command, with its flags and whether agents can run it without asking.

## Docs

- [Introduction](https://copybook.dev/docs.md): Treat the code snippets and agent prompts in your product as typed, tested, versioned content.
- [Quick start](https://copybook.dev/docs/quick-start.md): Define a command and a prompt, then render them in your product.
- Concepts
  - [Definitions](https://copybook.dev/docs/concepts/definitions.md): Commands, snippets, prompts, and collections.
  - [Params](https://copybook.dev/docs/concepts/params.md): Typed values with examples, defaults, and secrets.
  - [Templates](https://copybook.dev/docs/concepts/templates.md): The t tag, embedding, indentation, and text output.
  - [Variants](https://copybook.dev/docs/concepts/variants.md): One snippet in many frameworks, setups, and scenarios.
  - [Snapshots](https://copybook.dev/docs/concepts/snapshots.md): Rendered output committed next to your code, so every change shows up in review.
- Guides
  - [Coding agents](https://copybook.dev/docs/guides/agents.md): Let coding agents find, edit, snapshot, and test your definitions, through the CLI, MCP, and Studio.
  - [Modeling a console](https://copybook.dev/docs/guides/modeling-a-console.md): How Neon's onboarding screens map to definitions.
  - [Studio](https://copybook.dev/docs/guides/studio.md): Browse, preview, and trace every definition in a local UI.
  - [Testing snippets and commands](https://copybook.dev/docs/guides/testing.md): Parse, typecheck, and run what you show users.
  - [Evals](https://copybook.dev/docs/guides/evals.md): Give prompts to coding agents and check what they did.
  - [CI](https://copybook.dev/docs/guides/ci.md): Check snapshots, test changes, comment on pull requests, and run evals.
- Components
  - [Overview](https://copybook.dev/docs/components.md): shadcn components that render definitions, installed with shadcn add.
  - [Agent Prompt](https://copybook.dev/docs/components/agent-prompt.md): A prompt to paste into a coding agent, with a copy button.
  - [Code Variants](https://copybook.dev/docs/components/code-variants.md): One snippet in several frameworks or setups, as tabs.
  - [Command Tabs](https://copybook.dev/docs/components/command-tabs.md): A command per package manager, with an optional agent prompt tab.
- Reference
  - [@copybook/core](https://copybook.dev/docs/reference/core.md): API reference for definitions, params, and rendering.
  - [@copybook/cli](https://copybook.dev/docs/reference/cli.md): Commands, flags, JSON output, and exit codes.
  - [Config](https://copybook.dev/docs/reference/config.md): copybook.config.ts
- [Changelog](https://copybook.dev/docs/changelog.md): What changed in each release.