PureKit UI logoPureKit UI

Command-Line Interface (CLI)

Learn how to use the PureKit UI CLI to enhance your development workflow.

Getting Started

The PureKit UI CLI is a zero-config tool that scaffolds components directly into your project. No need to install any packages manually — the CLI handles everything.

1. Initialize your project

Run the init command to generate tailwind.config.mjs and update globals.css with color variables.

1npx @purekit-ui/cli init

2. Add components

Use the add command to scaffold components. Dependencies like tailwind-merge and clsx are installed automatically.

1npx @purekit-ui/cli add <ComponentName>

Usage

To add a new component, run the add command followed by the component's name. For example, to add a new Button component:

1npx @purekit-ui/cli add Button

This command will create a new folder for your component, typically at src/components/purekit-ui. If your project doesn't have a src directory, it will be placed in components/purekit-ui.

Available Commands

add <ComponentName>

Scaffolds a single component by name.

1npx @purekit-ui/cli add Button

add --all

Scaffolds all available components into your project.

1npx @purekit-ui/cli add --all

--list

Shows an interactive list of all available components and prompts you to choose one to generate.

1npx @purekit-ui/cli --list