Install raea

Install raea on macOS, Linux or Windows, update it, pin a version, and know which files it puts where.

View as Markdown

After this page you will have the raea command on your PATH and the raea skill installed for your coding agent.

Install

On macOS with Apple Silicon, or on Linux on x86_64:

Terminal
curl -fsSL https://raea.io/install | sh

On Windows 10 or 11, in PowerShell:

Terminal
irm https://raea.io/install.ps1 | iex

Then check that it worked:

Terminal
raea --version     # prints the version you installed
raea help          # lists every verb

The installer needs no account and no API key. Rendering, playing and checking all run on your own computer.

What goes where

PathWhat it holds
~/.raea/The engine, its runtime and SDK, and your settings file (~/.raea/env)
~/.local/bin/raeaA link to the raea command, so it is on your PATH
~/.claude/skills/raea/The raea skill, so Claude Code knows how to write and render with raea

If ~/.local/bin is not on your PATH, the installer says so and prints the line to add to your shell's profile.

Update

Run the installer again. It replaces the engine with the newest release that has a build for your machine and refreshes the skill:

Terminal
curl -fsSL https://raea.io/install | sh

Then see what changed in What's new.

Pick a version

Set RAEA_VERSION to install a particular release instead of the newest:

Terminal
RAEA_VERSION=0.1.0-canary.3 curl -fsSL https://raea.io/install | sh

On Windows:

Terminal
$env:RAEA_VERSION = "0.1.0-canary.3"; irm https://raea.io/install.ps1 | iex

Installer settings

SettingWhat it does
RAEA_VERSIONInstalls that release instead of the newest
RAEA_PREFIXInstalls somewhere other than ~/.raea
RAEA_NO_SKILLS=1Leaves the agent skill out
RAEA_DOWNLOADDownloads the release from a mirror or a local folder instead of GitHub

The skill for other agents

The installer adds the skill for Claude Code. For another agent, install it where that agent reads skills:

Terminal
raea skills install --agent codex     # also: claude, kimi, gemini

For Claude Code this also adds a hook that runs raea check --quick after each composition is saved and hands the agent what it finds. --no-hooks leaves the hook out.

If an agent's copy of the skill names a different version than raea --version prints, it should read raea skill instead: that is the skill exactly as your installed raea ships it.

Build from source

From a checkout of the repository:

Terminal
cargo build --release -p raea-cli     # the binary is target/release/raea

Supported systems

SystemStatus
macOS on Apple SiliconSupported
Linux on x86_64Supported. An app's window needs a display (X11, Wayland, or Xvfb on a server)
Windows 10 and 11 on x86_64Supported through install.ps1
Intel Macs, Linux on ARMNot yet