KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #typescript #ai-agent #developer-tools #claude-code #codex #deepseek-harness #ai-agents #react #mcp #rust

red

★ 217 Open GitHub ↗

:memo: Vimlike Modal Text Editor in Rust

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# red

[![CI](https://github.com/codersauce/red/actions/workflows/ci.yml/badge.svg)](https://github.com/codersauce/red/actions/workflows/ci.yml)
[![Plugin System Check](https://github.com/codersauce/red/actions/workflows/plugin-check.yml/badge.svg)](https://github.com/codersauce/red/actions/workflows/plugin-check.yml)
[![Release](https://github.com/codersauce/red/actions/workflows/release.yml/badge.svg)](https://github.com/codersauce/red/actions/workflows/release.yml)
[![Latest release](https://img.shields.io/github/v/release/codersauce/red)](https://github.com/codersauce/red/releases/latest)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://raw.githubusercontent.com/codersauce/red/main/LICENSE)
[![Discord](https://img.shields.io/badge/Discord-Join%20us-7289DA?logo=discord&logoColor=white)](https://discord.gg/5PWvAUNRHU)

> The modal editor for the agent era.

Fast, familiar editing with modern code intelligence and a safer way to work
with agents. One self-contained Rust binary. No required configuration. Your
files stay yours.

[Website](https://getred.dev) ·
[Download](https://github.com/codersauce/red/releases/latest) ·
[Getting started](docs/GETTING_STARTED.md) ·
[Documentation](#documentation) ·
[Community](https://discord.gg/5PWvAUNRHU)

The current documented release is
[v0.6.0](https://github.com/codersauce/red/releases/tag/v0.6.0).

![Red editing its Rust rendering pipeline with the project tree open](https://raw.githubusercontent.com/codersauce/red/main/docs/images/editor-overview.jpg)

## Husk language

The source tree contains the extracted Husk embedding API, standalone CLI, local
package resolver, and portable WebAssembly Component extension runtime. Start
with the [language and embedding guide](docs/HUSK_LANGUAGE_GUIDE.md). The
[research and implementation plan](docs/HUSK_LANGUAGE_EXTRACTION_PLAN.md) and
[card-by-card status](docs/HUSK_IMPLEMENTATION_STATUS.md) explain the dynamic
Rust-crate design, completed work, and remaining release-hardening tasks.

## Install

### Homebrew

```shell
brew install codersauce/tap/red
```

### macOS and Linux

```shell
curl --proto '=https' --tlsv1.2 -fsSL https://getred.dev/install.sh | sh
```

The installer selects the correct macOS or x86_64 glibc Linux archive, verifies
its published SHA-256 checksum, installs to `~/.local/bin`, and runs Red's
built-in self-check.

### Windows

```powershell
irm https://getred.dev/install.ps1 | iex
```

The PowerShell installer verifies the release checksum, installs to
`%LOCALAPPDATA%\Programs\Red\bin`, and adds that directory to your user PATH.

To pin a release or choose another directory:

```shell
RED_VERSION=0.6.0 RED_INSTALL_DIR="$HOME/bin" \
  sh -c "$(curl --proto '=https' --tlsv1.2 -fsSL https://getred.dev/install.sh)"
```

You can also download a
[prebuilt archive](https://github.com/codersauce/red/releases/latest) or
[build from source](#development). Red's editor, default configuration, themes,
and plugins are bundled into the executable.

Agent support is optional. It requires Codex CLI 0.144.1 or newer and a
completed `codex login`.

## Why Red

- **Stay in flow.** Vim-inspired modes, motions, text objects, splits, and
  pickers are paired with tree-sitter highlighting and asynchronous language
  tools.
- **Find the signal.** Jump to files, commands, symbols, definitions,
  references, diagnostics, or Git changes without leaving the keyboard.
- **Make it yours.** Embedded Husk plugins power the file tree, project search,
  Git workspace, and theme browser. Defaults work immediately; configuration
  remains optional.
- **See the work happen.** Red gives Codex editor context, including unsaved
  buffers, and follows each tool call by revealing the file and edit before it
  is applied and saved.
- **Work reliably.** Atomic recovery works across platforms, and Unix
  detach/attach sessions preserve buffers, plugins, LSP state, and running
  agents across terminal or SSH disconnects.

## First five minutes

Open a file:

```shell
red path/to/file
```

Red offers to create a starter config on the first interactive run. Declining
is fine: the embedded defaults, plugins, and themes are enough to start editing.

| Key | Action |
| --- | --- |
| `Space ?` | Discover commands and their effective keymaps |
| `Space m` | Browse notifications and recent messages |
| `Ctrl-p` | Find a file with fuzzy search and live preview |
| `Space G` | Open the Git status workspace |
| `Space A` | Ask the agent with editor context |
| `Space i` | Refactor the current line or visual selection inline |
| `Space t` | Browse themes with live preview |

See [Getting started](docs/GETTING_STARTED.md) for editing, navigation,
configuration, language servers, Git, CLI, and troubleshooting guidance. The
[Vim compatibility matrix](docs/VIM_COMPATIBILITY.md) is the precise,
versioned behavior contract.

## A visible agent workflow

![Red preparing a contextual agent prompt over the active source file](https://raw.githubusercontent.com/codersauce/red/main/docs/images/agent-workflow.jpg)

Agent edits happen through Red's editor transaction and save paths while you
follow along in the active buffer.

1. **Ask.** Open the agent with `Space A`; Red includes a bounded selection or
   cursor excerpt, unsaved contents, and relevant diagnostics.
2. **Follow.** Red reveals the target file and cursor before each bounded tool
   call, then briefly pauses so the change is readable.
3. **Continue.** Revision-checked edits are attributed to the Codex session,
   applied to the visible buffer, and saved to disk through Red.

The integration uses the Codex app-server directly and supports persistent
conversation, queued follow-ups, live tool progress, and explicit session
controls. Ignored, out-of-workspace, binary, and common secret files are
excluded from context. Read the
[agent workflow and safety contract](docs/AGENT_WORKFLOW.md) for prerequisites,
limits, commands, and failure behavior.

For a smaller blast radius, press `Space i` on a line or visual selection.
Inline assist opens beside the target, gives an ephemeral Codex thread only the
selected text and bounded surroundings, and accepts only one complete
replacement. The result is an unsaved, agent-attributed editor transaction;
keep it, undo it, refine it in the same popup, or escalate the changed range to
the full Agent panel.

## What Red ships today

The current release includes:

- Normal, Insert, Visual, Visual Line, Visual Block, and Command modes with
  expanding Vim motion and editing compatibility
- tree-sitter highlighting for Rust, Markdown, JavaScript, TypeScript/TSX,
  JSON, TOML, YAML, Bash, PowerShell, Lua, and Husk
- a first-party Husk language server plus built-in LSP defaults for Rust,
  TypeScript/JavaScript, Markdown, JSON, TOML, YAML, and Lua
- command and keymap discovery, fuzzy files, buffer navigation, symbols,
  references, project search, and diagnostics
- native Git gutter signs, hunk actions, and a full-screen workspace for
  staging, commits, branches, remotes, stashes, logs, and rebases
- an embedded Husk runtime with bundled file tree, search, Git, progress,
  inlay-hint, symbol, theme, and agent plugins
- a branded startup splash, the Red theme, accessible selection and cursor
  contrast, and optimized rendering hot paths
- atomic crash recovery on every platform and detachable sessions on macOS and
  Linux

See the [latest release notes](https://github.com/codersauce/red/releases/latest)
or the [complete changelog](CHANGELOG.md) for details.

After installing a new version, Red opens a themed **What’s new** panel once.
Reopen it whenever you like with `:whats-new`, `:changelog`, or the command
palette. Release notes are bundled for offline use and refreshed from the exact
matching GitHub release in the background.

## Configuration

Red layers your settings over embedded defaults, so a configuration file can
contain only the values you want to change:

```toml
# ~/.config/red/config.toml
theme = "red.json"
scrolloff = 8
# Disable the automatic release panel or its optional GitHub refresh:
# show_whats_new = false
# fetch_release_notes = false

[search]
ignorecase = true
smartcase = true

[keys.normal]
"Ctrl-s" = "Save"
```

The commented [`default_config.toml`](default_config.toml) documents every
setting that ships with Red. Custom themes go in `~/.config/red/themes/`, and
custom Husk plugins go in `~/.config/red/plugins/`. Run `red --runtime-files`
to see every visible runtime asset and its source.

Add new highlighting, exact filenames, comment syntax, indentation, and language
servers through a unified `[languages.<id>]` configuration or an installable
language pack. Native Tree-sitter grammars require explicit digest-bound trust;
`:languages reload` applies validated changes without restarting the editor.
See the [language extensions guide](docs/LANGUAGES.md).

## Plugins and themes

Bundled plugins and themes are embedded in the binary and upgrade with Red.
They are parsed and typechecked against the versioned Husk host contract before
activation; an incompatible plugin is quarantined without preventing editor
startup.

You can disable bundled plugins, configure them in `config.toml`, or eject a
copy for customization:

```shell
red --eject plugins/fidget.hk
red --eject themes/red.json
```

An ejected asset shadows the bundled copy until you delete it. See the
[plugin system guide](docs/PLUGIN_SYSTEM.md), [host API](docs/PLUGIN_API.md),
and [bundled plugin source](plugins/) for details and examples.

## Sessions

On macOS and Linux:

```shell
red --detach path/to/file
red --detach=work path/to/project
red --attach work
```

Leave a detachable session with `Ctrl-\`. Read
[Detachable sessions](docs/DETACH.md) and
[Session recovery](docs/SESSION_RECOVERY.md) for lifecycle, recovery, and
platform details.

## Documentation

| Guide | Covers |
| --- | --- |
| [Getting started](docs/GETTING_STARTED.md) | Editing, keymaps, LSP, Git, CLI, and troubleshooting |
| [Husk language server](docs/HUSK_LSP.md) | Husk editor features, external crates, configuration, and safety boundaries |
| [Language extensions](docs/LANGUAGES.md) | Custom syntax, trusted Tree-sitter grammars, language packs, LSP settings, and live reload |
| [Vim compatibility](docs/VIM_COMPATIBILITY.md) | Supported behavior and intentional differences |
| [Agent workflow](docs/AGENT_WORKFLOW.md) | Codex prerequisites, review model, commands, and safety |
| [Plugin system](docs/PLUGIN_SYSTEM.md) | Husk lifecycle, runtime architecture, and validation |
| [Plugin API](docs/PLUGIN_API.md) | Versioned host API for plugin authors |
| [Detach and attach](docs/DETACH.md) | Persistent Unix sessions |
| [Session recovery](docs/SESSION_RECOVERY.md) | Atomic recovery and dirty-buffer restoration |
| [Performance](docs/performance.md) | Measurement, budgets, and regression process |
| [Debugging](docs/DEBUGGING.md) | Invariant owners, logs, diagnostic commands, and tracing paths |
| [Releasing](docs/RELEASING.md) | Release preparation, publication, and verification |

## Status and community

Red is an early, pre-1.0 release and is evolving quickly. Bring curiosity and
keep backups for critical work.

- Follow development on the
  [CoderSauce YouTube channel](https://youtube.com/@CoderSauce).
- Join the [Discord community](https://discord.gg/5PWvAUNRHU).
- Report bugs and request features in
  [GitHub Issues](https://github.com/codersauce/red/issues).

## Development

Red requires a recent stable Rust toolchain and Git:

```shell
git clone https://github.com/codersauce/red.git
cd red
cargo build
cargo test --all-targets --all-features
cargo clippy --all-targets --all-features -- -D warnings
```

Use narrower commands while iterating on a specific crate or test:

```shell
cargo test -p red --lib editor::tests::
cargo test --workspace --exclude red --all-features --tests
python3 scripts/doctest_packages.py --no-default-features
```

`cargo test` is the default runner because Red's many short tests complete
faster in shared test-binary processes. Install `cargo-nextest` when per-test
isolation, timing, retries, or JUnit reports are useful, then compare both
runners with `python3 scripts/test_performance.py --runner both --timings`.
Add `--package husk-lexer` for a short, focused comparison.
The manual **Rust Test Performance** GitHub Actions workflow provides the same
comparison on Linux, macOS, or Windows and can optionally enable `sccache` or
the Linux `mold` linker.

Use `RED_RUNTIME=.` while iterating on bundled plugins or themes without
rebuilding the executable:

```shell
RED_RUNTIME=. cargo run -- path/to/file
```

Contributions are welcome. For major changes, open an issue before investing in
an implementation. Release maintainers should follow
[`docs/RELEASING.md`](docs/RELEASING.md).

## License

Red is available under the [MIT License](LICENSE).

Built with love for the Rust community and inspired by Vim, Neovim, and Helix.

red

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README