Copybook

Introduction

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

Developer tools ship a lot of copy-paste content: "Connect" dialogs with snippets in five languages, model pages with per-framework examples, and "paste this into your coding agent" prompts. That content usually lives as strings scattered across components, so nobody can easily answer:

  • What snippets and prompts do we show, and where?
  • Do all the code examples still work?
  • Do the prompts still perform well with today's agents?
  • When did each one last change?

Copybook answers these questions by making every snippet, command, and prompt a definition with a stable id, typed params, and declared placements. Your product renders definitions with real values. The CLI catalogs them, snapshots their rendered output so every change shows up in review, runs them in sandboxes, and evaluates prompts with real coding agents.

Version 0.x

Copybook is at 0.x, so minor releases can include breaking changes. The changelog lists them.

How it fits together

QuestionAnswered by
What existscopybook list, the manifest, and Studio
Where it's shownDeclared placements
When it changedRendered snapshots committed next to your code
Does it workcopybook test, with syntax, typecheck, and run tiers
Does it perform wellcopybook eval, which runs prompts through agent adapters

Packages

  • @copybook/core: isomorphic, zero-dependency definitions and rendering. This is what your product imports.
  • @copybook/cli: catalog, snapshots, tests, evals, and the local Studio.
  • Registry components: shadcn components for agent prompts, code variants, and command tabs. You install them with shadcn add.

On this page