Skip to main content
The reactor CLI is how you build and run a model. It is a single Go binary. The Python runtime and media libraries ship inside the image the CLI builds for your workspace, so your host needs just two things: the CLI, and a running Docker daemon.

​
Install the latest release

The installer detects your system: macOS or Linux, Intel or ARM. It checks the download against the release checksums, and it installs the binary to ~/.local/bin/reactor. It also adds ~/.local/bin to your shell startup file, so open a new terminal after it finishes:
Run the same command again to upgrade. To install somewhere else, set REACTOR_INSTALL_DIR on the shell that runs the installer:
Set REACTOR_NO_MODIFY_PATH=1 to keep your shell startup file unchanged. If the install directory is not on your PATH already, add it yourself.

​
Install with Homebrew

Homebrew still works on macOS and Linux. Use it if you prefer to install and upgrade the CLI with a package manager:
To upgrade an existing Homebrew install, run:

​
Upgrade the CLI

Run reactor upgrade to check for and install the latest CLI release. For a direct installation, the command checks the download and replaces the binary atomically. For a Homebrew installation, it runs brew upgrade reactor-cli. Pass --check to check without installing. During successful interactive commands, the CLI can print a notice when a newer version is available. It never installs an update until you run reactor upgrade.

​
Pin to a specific release

CI pipelines that need a reproducible install should pin a release instead of tracking latest. Set RELEASE to a version from releases.reactor.inc, where versioned tarballs are kept indefinitely. Download the archive and its checksums. Check the archive against the checksums before you unpack it. A corrupted or substituted download then fails the check instead of installing:

​
Windows

Not supported. Use WSL2, then run the installer above.

​
Verify

Sample output:
The reactor-runtime release belongs to the workspace, in build.runtime_version of reactor.yaml. A fresh reactor init pins the current release; reactor init --runtime-version overrides that pin at scaffold time, and bumping the value in reactor.yaml upgrades an existing workspace. The reactor command with no arguments prints a welcome screen. To print it again later, run reactor welcome.

​
Check your setup

reactor version only proves the binary runs. To check the rest, run reactor doctor. It checks Docker, the workspace config files, your API key, and the connection to the Reactor API. Each check prints one line, a failed check tells you how to fix it, and the command exits non-zero when any check fails.
Docker and the config files are what building and running a model locally depend on. The API key and connection checks only matter once you deploy, so a fresh install that fails those two can still build and run.

​
Next

Serve your own model

Bring your code and weights to a live, interactive app.

Model Anatomy

A working model read line by line.