CLI

The Veloria UI CLI copies components directly into your project — you own the code and can customize it freely.

Initialize

Run init once in your project root. It detects Next.js, writes a config file, and patches Tailwind.

bash

$npx veloria-ui init

Add components

Add one or more components. The CLI copies the source into components/ui/ (or wherever your atlas.config.json points) and installs any required npm packages.

css

# Add individual components
npx veloria-ui add button
npx veloria-ui add card modal drawer toast
 
# Custom output directory
npx veloria-ui add button --dir src/components/ui
 
# Skip npm install
npx veloria-ui add button --no-install

All commands

Command	Description
veloria-ui init	Set up Veloria UI in your project. Writes veloria.config.json, creates lib/utils.ts, patches tailwind.config.ts.
veloria-ui add <components>	Copy one or more components into your project. Resolves peer dependencies automatically.
veloria-ui remove <component>	Uninstall a component, warn about dependents, and update veloria.lock.json.
veloria-ui list	Browse all available components with descriptions.
veloria-ui list --category forms	Filter the component list by category.
veloria-ui diff button	Compare your local copy of a component against the latest upstream version.
veloria-ui upgrade	Three-state staleness detection: sync components without clobbering local edits.

veloria.config.json

The config file created by init:

json

{
  "$schema": "https://ui-veloria.vercel.app/schema.json",
  "style": "default",
  "typescript": true,
  "tailwind": {
    "config": "tailwind.config.ts",
    "css": "app/globals.css",
    "baseColor": "slate",
    "cssVariables": true
  },
  "aliases": {
    "components": "@/components/ui",
    "utils": "@/lib/utils"
  }
}

remove

Cleanly uninstall a component. The CLI warns if other components depend on it, then removes the files and updates veloria.lock.json.

bash

$npx veloria-ui remove button
# Warns: "modal depends on button — remove anyway? (y/N)"

diff

Compare your local copy against the upstream source without leaving the terminal.

bash

$npx veloria-ui diff button
# Shows a native terminal diff — your edits highlighted

upgrade

Three-state staleness detection keeps components in sync. Reports up-to-date, modified, or stale per component.

bash

$npx veloria-ui upgrade
# button  — up-to-date
# modal   — stale (upstream changed, local untouched) → auto-upgraded
# select  — modified (you edited it) → skipped, diff shown

Dark Mode Browse components