Installation

Create a New Project

The fastest way to get started is with create-dispersa. It scaffolds a project with tokens, a build script, and a ready-to-run configuration.

pnpm

pnpm create dispersa

npm

npm create dispersa@latest

Yarn

yarn create dispersa

Bun

bun create dispersa

You will be prompted to choose:

1. Project directory — where to scaffold the project
2. Template — TypeScript (programmatic build script with CSS output) or CLI (config-file workflow using the dispersa CLI)
3. Install dependencies — optionally run the package manager for you

Add to an Existing Project

If you already have a project and want to add Dispersa to it:

pnpm

pnpm add dispersa

npm

npm install dispersa

Yarn

yarn add dispersa

Tip

The dispersa package includes the CLI. No additional package is needed — run npx dispersa build once installed.

Global Installation

If you use the Dispersa CLI across multiple projects, installing it globally gives you direct access to the dispersa command without npx:

pnpm

pnpm add -g dispersa

npm

npm install -g dispersa

Yarn

yarn global add dispersa

Once installed globally, the dispersa command is available everywhere:

dispersa build

Caution

A global install is convenient for quick one-off builds, but for team projects you should still add dispersa as a local dependency. This ensures everyone on the team uses the same version.

Your First Build Run your scaffolded project and explore the generated output.