create-girih

Scaffold a girih design-system workspace.

npx create-girih my-ds
pnpm create girih my-ds
npm create girih my-ds
yarn create girih my-ds

It creates the directory, writes package.json, scaffolds the full workspace, then installs it with whichever package manager invoked it (pnpm create girih installs with pnpm, and so on). Scaffolding happens before the install, so a failed or skipped install still leaves a complete, readable project — --no-install opts out of installing entirely. The templates come from the same module girih init uses, so a workspace created either way is byte-identical.

Options

| Flag | | | ------------------ | ---------------------------------------------------------------------------------------- | | --name <package> | Published package name (default: @<directory>/design-system) | | --brand <name> | Default brand, lowercase kebab-case (default: main) | | --workspace | Link the girih packages by workspace protocol, for development inside the girih monorepo | | --no-install | Scaffold only, then print the commands to finish by hand |

What you get

Tokens in three tiers, one Button contract, a brand overlay, and a demo page that renders with no bundler. Then:

cd my-ds
girih check            # resolved token table + contract validation
girih generate react   # compile the design system package
open demo/index.html   # every variant, size and brand

Requires

Node >= 22.

Documentation

Nine chapters covering tokens, contracts, generation and every diagnostic: https://github.com/DariushStony/girih#readme

License

MIT