CLI

CLI Reference

Reference for Velyx CLI commands, installation flows, and day-to-day component management in Laravel projects.

Global Options

Display the installed CLI version.

velyx --version
velyx -v

Creates `velyx.json`, checks your environment, and prepares the component target path.

npx velyx@latest init

pnpm dlx velyx@latest init

yarn dlx velyx@latest init

bunx --bun velyx@latest init

Option	Alias	Description
--base-color	-b	Base color: neutral, gray, zinc, stone, slate.
--defaults	-d	Use default configuration.
--force	-f	Overwrite existing configuration.
--cwd	-c	Working directory.

Copies component files into your app and handles required dependencies and conflicts.

npx velyx@latest add button

pnpm dlx velyx@latest add button

yarn dlx velyx@latest add button

bunx --bun velyx@latest add button

npx velyx@latest add card input dialog

pnpm dlx velyx@latest add card input dialog

yarn dlx velyx@latest add card input dialog

bunx --bun velyx@latest add card input dialog

npx velyx@latest add --all

pnpm dlx velyx@latest add --all

yarn dlx velyx@latest add --all

bunx --bun velyx@latest add --all

Inspect available registry components from the command line.

npx velyx@latest list

pnpm dlx velyx@latest list

yarn dlx velyx@latest list

bunx --bun velyx@latest list

npx velyx@latest list --query button

pnpm dlx velyx@latest list --query button

yarn dlx velyx@latest list --query button

bunx --bun velyx@latest list --query button

npx velyx@latest list --json

pnpm dlx velyx@latest list --json

yarn dlx velyx@latest list --json

bunx --bun velyx@latest list --json