# Installation

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

## Requirements

- Node.js `>= 24.16`
- A package manager: npm, pnpm, or an equivalent `dlx` runner

## Run without installing

```bash
npx @klyro/cli --help
# or
pnpm dlx @klyro/cli --help
```

## Install globally

```bash
npm install -g @klyro/cli
klyro --help
```

:::note
Klyro is pre-1.0: workspace packages stay private until a deliberate release
change publishes them. If the registry does not yet list a release, build from
source instead.
:::

## Build from source

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

```bash
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

```bash
klyro --version
klyro --help
```

Then continue with the [Quickstart](/getting-started/quickstart/) to generate
your first stack.