Getting Started / Installation

Installation

Halo UI ships two ways. Install the package to use the components as a dependency, or run the CLI to copy the source into your project so you own and can edit every file. Either way you need React 18+ and Tailwind CSS v4.

# Option A — use it as a dependency
npm i @ui-halo/ui

# app root: @import "@ui-halo/ui/styles.css";
# then:     import { Button } from "@ui-halo/ui";


# Option B — copy the source into your project
npx @ui-halo/cli init                     # tokens + utilities
npx @ui-halo/cli add button field ping    # the components you want

# then:     import { Button } from "@/components/ui/button";

Copy the sourcenpx @ui-halo/cli add button