Installation Guide
Velocity UI provides a CLI for automated installation and a direct copy-paste method.
Method 1: CLI (Recommended)
The CLI is the fastest way to add components. it handles dependencies, creates files, and sets up your project automatically.
1. Initialize Project
terminal
npx vui-registry-cli-v1 init2. Add a Component
terminal
npx vui-registry-cli-v1 add spotlight-cardLocal Registry (Dev)
Point the CLI at your local site while developing. It will read /data/components.json from your local server.
terminal
set VELOCITY_LOCAL_REGISTRY_URL=http://localhost:3000
npx vui-registry-cli-v1 add premium-buttonDry Run
Preview file writes without modifying disk or installing dependencies.
terminal
npx vui-registry-cli-v1 add premium-button --dry-runMethod 2: Copy & Paste
Prefer total control? You can copy the source code directly from any component page and paste it into your project.
- Browse the components in the sidebar.
- Click the "Code" tab on the component page.
- Copy the code and create a new file in your
components/uifolder.
Requirements
- Node.js 18.0 or later
- React 18+ and Next.js 14+ (App Router recommended)
- Tailwind CSS for styling