Installation
Get Helix running in your project in under five minutes. This guide covers requirements, installation and the one config file you'll touch.
Requirements
Helix runs anywhere Node 18+ does. Before you start, make sure you have:
- Node.js
18.0or newer - A package manager (npm, pnpm or bun)
- A project with a bundler (Vite recommended)
Install the package
Add Helix and its peer dependencies with your package manager of choice:
$ npm install helix-ui @helix/core
Using a monorepo?
Install Helix in the workspace root and reference it from each package — the CLI resolves config upward automatically.
Configuration
Helix reads a single helix.config.js at your project root. Every option is optional — these are the defaults:
| Option | Type | Default |
|---|---|---|
| theme | string | "system" |
| prefix | string | "hx-" |
| strict | boolean | false |
| outDir | string | "./dist" |
Strict mode changes resolution
Turning on
strict will fail the build on any unresolved token. Enable it once your theme is stable. Next steps
You're set up. From here, most people head to theming or pull in their first components.