Installation

Requirements

No Rust, no system libraries, no native build tools required.

Create a new project

The fastest way to start:

npx veloxkit-cli create my-app

This scaffolds a new project with TypeScript, a starter component, and veloxkit.config.ts pre-configured.

Options:

npx veloxkit-cli create my-app --template notes       # sidebar + notes list app
npx veloxkit-cli create my-app --template dashboard   # stat cards + nav
npx veloxkit-cli create my-app --template settings    # Switch rows in Card sections
npx veloxkit-cli create my-app --template blank       # bare counter (default)
npx veloxkit-cli create my-app --no-git               # skip git init

Install in an existing project

Install the CLI as a dev dependency:

npm install --save-dev veloxkit-cli

Then add scripts to package.json:

{
  "scripts": {
    "dev": "veloxkit dev",
    "build": "veloxkit build",
    "package": "veloxkit package"
  }
}

Verify the install

npx veloxkit-cli --version
# veloxkit 0.3.0

Platform notes

macOS

On first run, macOS may show a Gatekeeper prompt. Right-click the binary and select Open to allow it, or run:

xattr -d com.apple.quarantine ~/.velox/runtime/veloxkit-runtime

Linux (Wayland)

VeloxKit defaults to X11 compatibility mode. To enable native Wayland:

VELOX_WAYLAND=1 npx veloxkit-cli dev

Or set display: "wayland" in veloxkit.config.ts.

Windows

On Windows, the runtime requires the Visual C++ Redistributable 2022. This is pre-installed on most systems. If you see VCRUNTIME140.dll not found, download it from Microsoft's website (opens in a new tab).