Skip to content
Klyro Docs

Installation

Klyro ships as an npm package, @klyro/cli, distributed through npm, npx, and pnpm dlx.

Requirements

Section titled “Requirements”
  • Node.js >= 24.16
  • A package manager: npm, pnpm, or an equivalent dlx runner

Run without installing

Section titled “Run without installing”
Terminal window
npx @klyro/cli --help
# or
pnpm dlx @klyro/cli --help

Install globally

Section titled “Install globally”
Terminal window
npm install -g @klyro/cli
klyro --help

Build from source

Section titled “Build from source”

The repository is a pnpm workspace with a frozen toolchain (pnpm 11.15.1, Vite+, Node >= 24.16). From a checkout:

Terminal window
vp install

This installs workspace dependencies, including the CLI under apps/cli. The repository’s development commands (vp check, vp test, vp run build) are described in the repository README; they matter when you want to change Klyro, not just use it.

Verify the installation

Section titled “Verify the installation”
Terminal window
klyro --version
klyro --help

Then continue with the Quickstart to generate your first stack.