Learn how to use the Rust UI CLI to install components, initialize projects, and manage your component library efficiently.

Installation

cargo install ui-cli --force

Commands

1. Starters (optional, quick start)

If you want to start very easily with all setup for you, run this:

ui starters # Optional, quick start

2. Init (existing projects)

If you want add components to an existing project, run this:

ui init

This command will setup everything for you to then add components easily.

3. Add

For adding new components, you just need to run this:

ui add button
# ui add demo_card demo_button
# └──> Works with any number of components

Getting Started

The Rust UI CLI provides a streamlined workflow for building component libraries in Rust. Whether you're starting a new project or adding components to an existing codebase, the CLI handles all the complexity for you.

Recommended workflow:

  1. Quick Start: Use ui starters if you want a complete project setup with example components
  2. Existing Projects: Use ui init to configure your current project for Rust UI components
  3. Add Components: Use ui add [component-name] to install individual components as needed

The CLI automatically manages dependencies, imports, and file structure, so you can focus on building your application instead of configuration.