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.

TypeScript Setup

Dispersa is written in TypeScript and ships with type definitions. No @types packages are required.

If you use TypeScript configs (tsconfig, etc.), ensure TypeScript 5+ for full compatibility.

ESM-Only Package

Dispersa is ESM-only. Add "type": "module" to your package.json when using the API or CLI in a Node.js project:

{
  "type": "module"
}

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