Install Red
For agentsllms.txtllms-full.txt

Getting started

View as Markdown/docs/getting-started/install.md
Open in ChatGPTStarts a chat that reads this pageOpen in ClaudeStarts a chat that reads this page

Install Red

Install the Red binary for your platform, then check that its bundled runtime is ready.

Choose an installation method

The install scripts support Apple Silicon and Intel Macs, x86-64 glibc Linux, and 64-bit x86-64 Windows. Homebrew is also available on macOS and Linux.

curl -fsS https://getrededitor.com/install.sh | sh

What the installer does

The shell and PowerShell installers download the release archive for your platform, compare it with the published SHA-256 checksum, install the binary, and run Red's self-check. They also enable managed updates for your standalone installation.

Already have Red? See Update Red for manual updates and migrating an older installation.

  • On macOS and Linux, the default destination is ~/.local/bin/red.
  • On Windows, the default destination is %LOCALAPPDATA%\Programs\Red\bin\red.exe. The installer adds that directory to your user PATH.

Check the installation

Open a new terminal if the red command is not available immediately, then run:

Shell
red --version
red --self-check

The self-check lists the bundled plugins and finishes with red self-check ok. Agent support is optional and has its own setup check.

Open a project

Shell
red -r path/to/project

Red works without a configuration file. The default configuration, plugins, and themes are embedded in the binary.

Continue with your first session