0.1.0 Beta

Quick Start Guide

Get up and running with Boreal UI in just a few steps. Choose your framework, configure your defaults, and copy the generated setup code.

Step 1 of 6Install
1

Install the Package

Select your framework, then choose manual install or the Boreal UI CLI.

Framework

Guided CLI setup

Let the CLI add Boreal UI, wire global styles, create or update ThemeProvider setup, and apply safe defaults for the selected framework.

bash
npx @boreal-ui/cli@latest init --framework next --recommended-globals --dry-run
npx @boreal-ui/cli@latest init --framework next --recommended-globals --yes
CLI reference

Manual package install

Install the package yourself, then continue through the next steps to add ThemeProvider, globals, config, and component imports.

bash
npm install @boreal-ui/next
npm install -D @boreal-ui/types