Red documentation

Installation

Red is distributed as a self-contained binary. Choose the detected method or switch platforms manually.

The shell and PowerShell installers select a supported release archive, verify its published SHA-256 checksum, install Red, and run its built-in self-check.

Quick start

Open a file or directory from your terminal:

red path/to/file

On the first interactive run, Red can create a starter configuration. Declining is fine: the embedded defaults, plugins, and themes are enough to begin.

red --version
red --self-check

Keybindings

Red combines Vim-inspired modal editing with discoverable project commands.

Agent workflow

Red gives Codex bounded editor context—including unsaved buffers—while keeping suggested writes in an isolated proposal filesystem.

1. Ask. Press Space A with a selection or from the current buffer.
2. Review. Open :AgentReview to inspect pending changes.
3. Decide. Accept useful hunks and reject the rest. Nothing is silently written.

Themes

Press Space t to browse the bundled gallery and preview themes live. The selected theme can be stored in your configuration.

Plugins

Red includes a typed Husk runtime. Bundled Husk plugins power core tools such as the file tree, project search, Git workspace, theme browser, progress UI, and agent interface.

Configuration

Configuration is optional. Start with the generated file, then change only what you want to own.

# ~/.config/red/config.toml
# Red's generated starter documents the available sections.

Run red --self-check whenever you want to verify the editor, configuration, and optional agent prerequisites.