Docs

Installation

Velocity Components ships shadcn-style: a CLI copies a component's source straight into your project. There's no package to add to package.json and nothing to import from a Velocity package at runtime.

Current state: not on npm yet

@aidxn/velocityx-cli has not been published. npm install -g @aidxn/velocityx-cli will fail today — npm view returns a 404, and the package is still marked private in its own manifest.

If you're a subscriber and want to try it before it's public, email hi@aidxn.com for the current build. Everything below is the flow once the package is public — it's the same shape either way, just the first line changes.

1. Install the CLI

Once published:

bash

npm install -g @aidxn/velocityx-cli

2. Install the theme — run this first, once per project

Every component is written against primary and accent colour scales. Those scales don't exist in a project that hasn't installed the Velocity Tailwind preset — skip this step and every component you add will render with no colour at all, silently, because the Tailwind classes just compile to nothing.

bash

velocityx theme

This writes velocity-theme/velocity-preset.cjs and velocity-theme/velocity-theme.css, then prints two manual steps: add the preset to your tailwind.config.js, and import the CSS file from your global stylesheet. It never overwrites a theme file that already exists — pass --force if you deliberately want to re-pull it.

3. Add a component

bash

velocityx add <slug>

Files land under src/ by default — right for Astro, Next's src/ layout, and Vite alike. A paid component asks for a licence key first:

bash

velocityx login vx_live_your_key_here

Flags

Flag	Commands	Does
--dest <dir>	add, theme	Project root the files are written under. Default `src` for `add`, `velocity-theme` for `theme`.
--force	add, theme	Overwrite a file that already exists. Warns first if the on-disk content has changed since install.
--registry-version <v>	add	Pin to a registry version. The registry only ever serves "latest" today — this fails loudly rather than silently installing latest under a version number that wasn't honoured.