Untitled UI CLI

The official command-line tool for Untitled UI React—scaffold projects, add components and page examples, search the library, and upgrade your project, all from your terminal. Just run, pick, and build.

Learn more • Documentation • Figma • FAQs

Documentation

Check out our documentation here → untitledui.com/react/docs/cli

Installation

We recommend using npx to always run the latest version:

npx untitledui@latest <command>

Or install globally:

npm install -g untitledui

Requires Node.js 18 or later.

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

# Search the library in natural language
npx untitledui@latest search "dark pricing table"

# Authenticate for PRO access
npx untitledui@latest login

Commands

init

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

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 the available brand colors | | -c, --color <name> | Set the brand color | | -y, --yes | Non-interactive mode — use defaults (for AI/CI) | | --license <key> | API key for PRO access (alternative to stored config) | | --lib-version <ver> | Component library version (7 or 8) |

add

Add one or more 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> | Path to add the component to | | -d, --dir <directory> | Directory where the project is located | | -t, --type <type> | Component type (base, marketing, shared-assets, application, foundations) | | --include-all-components | Include all base components without prompting | | -y, --yes | Non-interactive mode — use defaults (for AI/CI) | | --license <key> | API key for PRO access (alternative to stored config) | | --lib-version <ver> | Component library version (7 or 8) |

example

Add a full page example to your project.

npx untitledui@latest example [example] [options]

| Option | Description | | --------------------------- | --------------------------------------------------------- | | -o, --overwrite | Overwrite existing files | | -p, --path <path> | Path to add the components to | | -e, --example-path <path> | Path to add the example file to | | --include-all-components | Include all components from the example without prompting | | -y, --yes | Non-interactive mode — use defaults (for AI/CI) | | -c, --color <name> | Brand color (passed through to init) | | --license <key> | API key for PRO access (alternative to stored config) | | --lib-version <ver> | Component library version (7 or 8) |

search

Search components, templates, and icons using natural language.

npx untitledui@latest search <query...> [options]

| Option | Description | | ---------------------- | ------------------------------------------------------------------------- | | -t, --type <type> | Filter by type: components, templates, icons, all (default all) | | -l, --limit <number> | Max results per category (default 5) | | -k, --key <key> | API key for PRO access | | --lib-version <ver> | Component library version (7 or 8) |

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.

migrate

Migrate components for RTL (right-to-left) support.

npx untitledui@latest migrate [path] [options]

| Option | Description | | -------------- | ------------------------------------- | | --dry-run | Preview changes without writing files | | --skip-icons | Skip directional icon swapping | | -y, --yes | Skip prompts and use defaults |

upgrade

Upgrade your project to the latest version of Untitled UI.

npx untitledui@latest upgrade [options]

| Option | Description | | --------------- | ------------------------------------- | | --dry-run | Preview changes without writing files | | --skip-theme | Skip theme.css replacement | | --skip-deps | Skip dependency updates | | --skip-config | Skip config file updates | | --path <dir> | Directory to scan for source files | | -y, --yes | Skip prompts and use defaults |

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

Resources

Untitled UI React is built on top of Untitled UI Figma, the world's largest and most popular Figma UI kit and design system. Explore more:

Untitled UI Figma: The world's largest Figma UI kit and design system. Untitled UI Icons: A clean, consistent, and neutral icon library crafted specifically for modern UI design. Untitled UI file icons: Free file format icons, designed specifically for modern web and UI design. Untitled UI flag icons: Free country flag icons, designed specifically for modern web and UI design. Untitled UI avatars: Free placeholder user avatars and profile pictures to use in your projects. Untitled UI logos: Free fictional company logos to use in your projects.

Bug reports

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

License

The Untitled UI CLI (this tool) is licensed under the MIT license, which means you can use it for free in unlimited commercial projects.

[!NOTE] The MIT license covers the CLI tool only. The components, page examples, Storybook files, and other assets the CLI downloads are subject to a separate license agreement. Untitled UI React PRO includes hundreds more advanced UI components and page examples.

Untitled UI license agreement →

Frequently asked questions →