CLI

Command Line Interface (CLI)

The CLI is designed to help you set up your project with Intent quickly and efficiently. It’s the easiest and most convenient way to install Intent, allowing you to get started with your project in just minutes.

Existing Project

If you already have a project set up—whether it’s built with Laravel, Next.js, Remix, Tanstack, or any other framework—simply run the following command to install Intent:

This command will prompt you to confirm your project’s setup. However, the CLI is smart enough to detect your project type and provide default values.

Start a New Project

The CLI is highly flexible and can automatically detect whether you already have a project set up. If you don’t, you can start fresh by running the init command like this:

Add

The add command lets you install various types of components from the registry like UI components, hooks, libraries, styles, and more. By default, it installs UI components (--type ui), so you don’t need to specify the type unless you're adding something else.

Components

Once you’ve set up Intent, you can start adding components easily using the add command:

Lib

To add a library like primitive, use the --type lib option:

Hooks

To add a hook like use-media-query, use the --type hook option:

You can also use -t as a shortcut for --type:

Overwrite

To overwrite an existing component, use the --overwrite flag:

Or use the -o shorthand:

Style

It currently offers 5 starter styles, including blue, indigo, emerald, and sky. You can swap out default with any style you prefer:

Alias

If you’re tired of typing npx @intentui/cli@latest, you can create an alias for the CLI by adding the following line to your .bashrc or .zshrc file:

alias intentui='npx @intentui/cli@latest'

Then you can run the CLI using the intentui command:

intentui [command]

Shadcn CLI

You might notice that we provide our own CLI, but if you prefer using the ShadCN CLI, that's totally fine. To get started, initialize your application with the following command:

It currently offers 5 starter styles, including blue, indigo, emerald, and sky, so you can replace default with any style you prefer.

Once initialized, you can add components by running:

Let’s say you want to add a card component. Just replace <component> with card, like this: