Installation

Requirements

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

Install the CLI

The recommended approach is a global install — do it once and glyx is available in any directory:

npm install -g glyx-cli

Then verify:

glyx --version
# glyx 0.3.0

Create a new project

glyx create my-app
cd my-app

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

Available templates:

glyx create my-app --template dashboard

Install project dependencies

Inside the new project, install JS dependencies with whichever package manager you prefer — Glyx detects it automatically from the lockfile:

npm install

Then start the dev server:

glyx dev

Add to an existing project

Prefer a local install scoped to one project? Install as a dev dependency and run via package.json scripts:

npm install --save-dev glyx-cli

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

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 ~/.glyx/runtime/glyx-runtime

Linux (Wayland)

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

GLYX_WAYLAND=1 glyx dev

Or set display: "wayland" in glyx.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).