1# npm — `-g` is npm's global-install flag
2npm install -g @theme-kit/cli
3
4# pnpm uses the long `--global` form
5pnpm add --global @theme-kit/cli
6
7# yarn (yarn 2+ with global support)
8yarn global add @theme-kit/cli

Installing globally: each package manager spells it differently. npm uses npm install -g <pkg>, pnpm uses pnpm add --global <pkg>, and yarn uses yarn global add <pkg>. In a team, prefer project-local so the version is reviewed and reproducible.

After a global install, theme-kit is on your shell's PATH and runs from any directory. The packager writes a small shim for every platform, so theme-kit works identically from Windows cmd, Windows PowerShell, macOS Terminal (bash/zsh), and Linux (bash).

bash

theme-kit --version
theme-kit --help

2. On demand with npx (zero install)

npx ships with Node and downloads the package when you run it:

bash

npx --yes @theme-kit/cli generate --seed "#6366f1"

npm, pnpm, yarn, and bun all resolve the same package name.

3. Add it to one project (best for teams)

Lock the command into package.json so every teammate and every pipeline runs the identical version:

json

1{
2  "scripts": {
3    "theme:generate": "theme-kit generate --seed \"#6366f1\" --family indigo --output theme.json"
4  },
5  "dependencies": {
6    "@theme-kit/cli": "workspace:*"
7  }
8}

bash

npm run theme:generate

A project-local dependency is deterministic: version bumps are reviewed in the same PR that changes the script, so machines and humans agree.

Prefer a direct alias instead of installing?

If you already have a clone or a built copy, you can alias a subpath:

bash

alias theme-kit="node /path/to/theme-kit/dist/cli.cjs"

Verify the executable, not the workspace

A package's bin only proves portable if you test it from a separate directory — not just from inside this monorepo. From any empty folder:

bash

mkdir theme-kit-cli-test
cd theme-kit-cli-test
npx --yes @theme-kit/cli --version

That confirms the published package resolves your executable rather than a workspace shortcut.

Next: Quick Start.