Add a component
Install a component from the catalog, or start a new one from a contract.
Use the catalog for a component as shipped. Design a new one when it is not in the catalog or you want to redo it: run sketchbook add "<Name>" --blank, then write its contract (see Contracts).
Install from the catalog
-
See what is available.
listis read-only.sketchbook list --available -
Preview. The dry run shows what
addinstalls: contract, code, stories, specs and any dependencies.sketchbook add button --dry-run -
Install. Dependencies come first, and
addends by running the checks that cover a component (C1, C2, C3, P1, R1, T2, T4). Multi-word names need no quotes.sketchbook add button sketchbook add Button Group -
Confirm.
sketchbook list --installed
In Claude Code, /add <Component Name> runs the dry run, shows the result, then installs.
Remove a component
remove refuses while another component or a kit needs it, and refuses a team-made or customized component without --yes. Otherwise it removes the files, sets the registry status to planned and rebuilds.
sketchbook remove spinner --dry-run
sketchbook remove spinner
Warning
A team-made component cannot be restored from the catalog. Commit before you pass
--yes.
Kits
Kits are whole pages and blocks built only from components and semantic tokens. sketchbook kits add sign-in brings the kit and its components; sketchbook kits list lists them; kits remove asks for --yes when you edited one. /kits in Claude Code adds or adapts them, test-first. Check K1 keeps the catalog in step with src/patterns/.
| Kit | What it is |
|---|---|
sign-in |
Sign-in and sign-up pages |
settings |
A preferences page: tabs, each a card-wrapped form |
data-table |
A list page: search, filter, selectable table, pagination, empty and loading states |
dashboard |
An overview page: stat cards, chart, recent activity |
profile |
An account page |
docs-article |
A long-form documentation page |
onboarding |
First-run screens |
form-states |
Every form control in its default, disabled, invalid and read-only states |
Once added, a kit is team-owned: edit it freely.
Next steps
- Contracts: what a component spec holds.
- Components CLI: every option of
add,remove,listandkits.