CLI

The Benflux UI CLI lets you add components to any React or Next.js project without manually copying files. It handles dependency installation and file placement automatically.

Installation

No global install needed — run with npx:

npx benflux-ui@latest init

Interactive component picker

Run npx benflux-ui add without arguments to open the interactive picker — exactly like shadcn/ui. Use ↑↓ to navigate, Space to select, Enter to confirm.

npx benflux-ui add

# ◆  Which components would you like to add?
# │  ○ accordion        Feedback — Collapsible content sections
# │  ○ alert           Feedback — Contextual feedback messages
# │  ● button          Inputs — A flexible button component
# │  ○ card            Layout — Versatile content container
# │  ● dialog          Feedback — Modal overlay for actions
# │  ...

Configuration file

Running init creates benflux-ui.json at the root of your project:

benflux-ui.json

{
  "$schema": "https://benflux-ui.vercel.app/schema.json",
  "style": "default",
  "typescript": true,
  "tailwind": {
    "config": "tailwind.config.ts",
    "css": "src/app/globals.css",
    "baseColor": "default"
  },
  "aliases": {
    "components": "@/components/ui",
    "utils": "@/lib/utils"
  }
}

Commands

npx benflux-ui init

Initialize Benflux UI in your project. Auto-detects framework (Next.js, Vite, Remix, Astro), creates benflux-ui.json config, installs @benflux-ui/react, and writes lib/utils.ts.

Option	Description
--yes, -y	Skip all confirmation prompts
--typescript	Force TypeScript setup
--tailwind-v4	Use Tailwind CSS v4 syntax

npx benflux-ui add [components...]

Add one or more components to your project. When called without arguments, opens an interactive multi-select list of all 80+ components — use Space to toggle, Enter to confirm. Automatically installs required dependencies.

Option	Description
--yes, -y	Skip confirmation prompts
--overwrite	Overwrite existing component files
--path <dir>	Custom output directory

npx benflux-ui list

List all available components grouped by category, with installed status.

Option	Description
--json	Output as JSON

npx benflux-ui theme <action> [name]

Manage themes. Actions: install, list, remove. Theme names: default, ocean, aurora, sunset, forest, rose, midnight, slate.

Examples

# Initialize without prompts
npx benflux-ui init --yes

# Interactive picker — select from all 80+ components
npx benflux-ui add

# Add specific components directly
npx benflux-ui add button card input badge dialog

# Add multiple at once, overwrite existing
npx benflux-ui add button input --overwrite

# List all available components
npx benflux-ui list

# List as JSON (useful for scripting)
npx benflux-ui list --json

# Install a theme
npx benflux-ui theme install ocean