untitledui

Untitled UI CLI

The official CLI for Untitled UI React — quickly scaffold projects, add components, and install page examples with an interactive interface.

Installation

We recommend using npx to always run the latest version:

npx untitledui@latest <command>

Or install globally:

npm install -g untitledui

Quick Start

# Create a new project
npx untitledui@latest init my-app --nextjs

# Add components to an existing project
npx untitledui@latest add button toggle avatar

# Add a page example
npx untitledui@latest example dashboards-01/05

# Authenticate for PRO access
npx untitledui@latest login

Commands

init

Initialize a new project or configure an existing one with Untitled UI.

npx untitledui@latest init [directory] [options]

Option	Description
--vite	Initialize a Vite project
--nextjs	Initialize a Next.js project
-o, --overwrite	Overwrite existing files
--colors-list	Show available brand colors
-c, --color <name>	Set the brand color

Examples:

npx untitledui@latest init my-app --nextjs
npx untitledui@latest init my-app --vite --color blue

add

Add components to your project.

npx untitledui@latest add [components...] [options]

Option	Description
-a, --all	Add all available components
-o, --overwrite	Overwrite existing files
-p, --path <path>	Custom components directory
-d, --dir <directory>	Project directory
-t, --type <type>	Component type (base, marketing, shared-assets, application, foundations)

Examples:

npx untitledui@latest add button
npx untitledui@latest add button toggle avatar
npx untitledui@latest add --all --type marketing

example

Add a page example to your project.

npx untitledui@latest example [example] [options]

Option	Description
-o, --overwrite	Overwrite existing files
-p, --path <path>	Custom components directory
-e, --example-path <path>	Custom example file directory

Examples:

npx untitledui@latest example application
npx untitledui@latest example dashboards-01/05

login

Authenticate with Untitled UI to access PRO components.

npx untitledui@latest login

Opens a browser window for authentication. Your credentials are stored locally at ~/.untitledui/config.json.

Configuration

The CLI detects your project setup automatically:

• Framework: Next.js (App/Pages Router) and Vite
• Package manager: npm, yarn, pnpm, and bun
• TypeScript: Reads tsconfig.json for path aliases
• Tailwind CSS: v4+ with automatic dependency installation
• Custom paths: Supports components.json for alias configuration

Documentation

Full documentation is available at untitledui.com/react/docs.

Bug Reports

Found a bug? Please report it on our issue tracker.

License

MIT © Untitled UI