Sketchbook
Quickstart How it works

Create a design system with the published CLI. Quickstart · @usesketchbook/cli on npm

What you get

  • A spec you own. Foundations in brand.config.json, semantic tokens and component contracts in spec/. Every output is rebuilt from them.
  • Checks that can fail. 26 deterministic checks, including one maintainer-only check, with tests that show them failing on broken fixtures. The commit hook runs the standard checks.
  • A component library as one output. 38 components in the demo, a starting point you can edit or replace.
  • A CLI for all of it. Commands and options, generated from the code.
  • Agent guidance. Compatibility explains the available instructions and client-specific hooks.
  • Honest numbers. Status is computed from the repository; Evidence lists every study, including what did not work.

Where to go next

  • Start a design system: create a project, set your brand, run your first check.
  • Bring your tokens: import DTCG, Tokens Studio or CSS variables as a reviewed proposal.
  • Evidence: the studies, benchmarks and tests behind the system, including what did not work.
  • Add it to an app: add the harness in its own folder, with one script in your package.json.
  • Troubleshooting: what a failing check or a silent Claude layer means.
  • Reference: config files, contract format, checks, rules, glossary.

View as Markdown