ui8kit CLI

Official CLI for bootstrapping and managing UI8Kit component workflows in Vite React projects.

Requirements

• Node.js >=18
• A Vite React project (for init and add)

Quick Start

bunx ui8kit@latest init

Initialize with defaults (non-interactive):

bunx ui8kit@latest init --yes

Commands

init

Initialize UI8Kit structure and config in the current project.

bunx ui8kit@latest init
bunx ui8kit@latest init --yes
bunx ui8kit@latest init --registry ui

Options:

• -y, --yes Skip prompts and use defaults
• -r, --registry <type> Registry type (default: ui)

add

Install one or more components from the registry.

bunx ui8kit@latest add button
bunx ui8kit@latest add button card
bunx ui8kit@latest add --all
bunx ui8kit@latest add badge --force
bunx ui8kit@latest add button --dry-run
bunx ui8kit@latest add --all --retry

Options:

• -a, --all Install all available components
• -f, --force Overwrite existing files
• -r, --registry <type> Registry type (default: ui)
• --dry-run Show planned actions without writing files
• --retry Enable retry logic for unstable connections

scan

Scan source files and generate a registry manifest.

bunx ui8kit@latest scan
bunx ui8kit@latest scan --cwd ./apps/engine
bunx ui8kit@latest scan --source ./src --output ./src/registry.json

Options:

• -r, --registry <type|path> Registry type/path (default: ui)
• -o, --output <file> Output registry file
• -s, --source <dir> Source directory to scan
• --cwd <dir> Working directory

build

Build a publishable registry from a registry JSON file.

bunx ui8kit@latest build
bunx ui8kit@latest build ./src/registry.json
bunx ui8kit@latest build ./src/registry.json --output ./packages/registry/r

Options:

• [registry] Path to registry JSON (default: ./src/registry.json)
• -o, --output <path> Output directory (default: ./packages/registry/r)
• -c, --cwd <cwd> Working directory

Typical Flow

# 1) Initialize project
bunx ui8kit@latest init --yes

# 2) Add a component
bunx ui8kit@latest add button

# 3) Add everything from registry (optional)
bunx ui8kit@latest add --all

Local Development (this package)

From packages/cli:

npm install
npm run dev

Build once:

npm run build

Run compiled CLI locally:

node dist/index.js --help