Getting Started

Getting Started

AsheeUI is a config-driven React component library built on Tailwind CSS v4. It gives you a complete set of accessible, styled components with a unified configuration system that lets you set defaults once and override them anywhere.


Requirements

  • React 18 or newer
  • Tailwind CSS v4
  • Node.js 18 or newer

Installation

AsheeUI supports three major React frameworks. Choose your path:


Quick start

The fastest way to get AsheeUI running is with the CLI. Run this in your project root:

pnpm dlx @asheeui/cli@latest init

The CLI detects your framework, installs dependencies, adds the provider to your root layout, and configures Tailwind.

After the CLI finishes, open your app and render a Button:

jsx
import { Button } from "asheeui";
function App() {
return <Button>Hello AsheeUI</Button>;
}

You should see a styled button with the default theme.

Note: If you're adding AsheeUI to an existing project, npx asheeui init is still the recommended approach. It safely modifies your existing files.

Next

Next.js →