Velyx CLI is a command-line tool for adding UI components to Laravel projects.
It delivers composable UI components built with Blade, Alpine.js, and Tailwind CSS v4. Inspired by shadcn, Velyx gives you the code, not a dependency.
- A code delivery tool for Laravel UI components
- A way to copy components into your project
- A workflow that keeps you in control of your code
- Not a UI framework
- Not a runtime dependency
- Not an auto-updating system
- Not magic
Once components are added, they belong to your project.
Velyx assumes a modern Laravel setup:
- Laravel
- Blade
- Alpine.js
- Tailwind CSS v4 or higher
Tailwind v3 is not supported.
Velyx can be executed without installation.
npx velyx@latest initThis command:
- checks your environment
- prepares the UI components directory
npx velyx@latest add buttonVelyx will:
- fetch the component from the registry
- resolve its dependencies
- copy the files into your project
By default, components are placed in:
resources/views/components/uinpx velyx@latest listnpx velyx@latest searchVelyx can be used without installation via npx, but you can also install it globally for frequent use:
npm install -g velyx@latest
# or
pnpm add -g velyx@latestFor development releases (beta/next tags):
npx velyx@latestVelyx does not update your code automatically.
If a component changes in the registry and you want the new version:
- run
npx velyx@latest add <component>again - review the changes
- decide what to keep
This is intentional.
Velyx follows a simple principle:
You own your UI code.
There are no hidden abstractions and no vendor lock-in. Velyx exists to help you move faster, not to take control away from you.
After running npx velyx@latest init, a velyx.json file is created in your project root. This file stores your Velyx configuration and can be customized to your needs.
Full documentation is available at velyx.dev:
- Introduction
- Getting started
- Component reference
- Project philosophy
Technical documentation for testing architecture:
- Registry: registry.velyx.dev
- Documentation: velyx.dev
- GitHub: github.com/velyx-labs/cli
MIT
