# Red documentation

> Red is a modal text editor with Vim-style editing, language-server support, and extensible plugins.

These pages document Red v0.9.1. Check red --version first and follow each guide's minimum version and tested-baseline notes. The published release is not a claim that every page was tested against that version. Start with the guide for agents when choosing commands or APIs.

## Start here

- [For coding agents](https://getred.dev/docs/for-agents.md): Choose version-appropriate instructions, configure language tools, build plugins, and validate changes in Red.
- [Use Red](https://getred.dev/docs.md): Install the editor, complete a short first session, then move into the parts of Red you need.

## Install and update

- [Install Red](https://getred.dev/docs/getting-started/install.md): Install the Red binary for your platform, then check that its bundled runtime is ready.
- [Update Red](https://getred.dev/docs/getting-started/updating.md): Check for new releases, update a standalone installation, and migrate an older install.
- [Your first session](https://getred.dev/docs/getting-started/first-session.md): Open a project, edit and save a file, and learn where Red keeps its commands and shortcuts.

## Configure Red and language servers

- [Configure Red](https://getred.dev/docs/configuration.md): Keep the embedded defaults and add only the settings you want to change.
- [Language tools](https://getred.dev/docs/languages.md): Use completion, diagnostics, navigation, formatting, and language packs for the files in your workspace.
- [TypeScript and ESLint (multiple language servers)](https://getred.dev/docs/languages/typescript-eslint.md): Attach TypeScript and ESLint language servers to the same buffer, keep Prettier formatting, and troubleshoot multi-server setups.
- [Change keybindings](https://getred.dev/docs/keybindings.md): Map actions, action sequences, chords, and plugin commands without changing how keys behave in other modes.
- [Choose and edit themes](https://getred.dev/docs/themes.md): Preview bundled themes, keep a selection, or eject a JSON theme into your configuration directory.

## Develop plugins

- [Manage plugins](https://getred.dev/docs/plugins.md): Inspect bundled plugins, install external packages, control their lifecycle, and keep native grammar approval explicit.
- [Write a JSON-RPC plugin](https://getred.dev/docs/plugins/json-rpc.md): Build a live Markdown outline and table of contents plugin in TypeScript or Python with Red's JSON-RPC host API.
- [Write a Husk plugin](https://getred.dev/docs/husk.md): Use Red's embedded Husk language to register commands, keep private state, and request editor-owned operations.

## Use editor commands and sessions

- [Navigate and edit](https://getred.dev/docs/editor/navigation.md): Move through a project with Red's file tools and use its Vim-style editing model without guessing which commands are available.
- [Search and replace](https://getred.dev/docs/editor/search.md): Search one buffer, the whole project, or the file tree, and make controlled replacements with Red's regular-expression syntax.
- [Buffers and windows](https://getred.dev/docs/editor/windows.md): Arrange files in splits, move between editor and plugin panes, and resolve files that changed outside Red.
- [Work with Git](https://getred.dev/docs/git.md): Review changes, stage hunks or lines, write commits, and use repository operations without leaving Red.
- [Agent and inline assist](https://getred.dev/docs/agent.md): Set up Codex, use the full Agent workspace or a bounded inline request, and know when a change is saved to disk.
- [Detach and recover](https://getred.dev/docs/sessions.md): Keep a live editor across terminal disconnects on macOS and Linux, or restore an atomic snapshot after the editor stops.
- [Command-line reference](https://getred.dev/docs/reference/cli.md): Look up Red's editor, validation, runtime asset, Agent, session, plugin, language, and keyboard commands.
- [Vim compatibility](https://getred.dev/docs/reference/vim.md): See which Vim-style editing behaviors Red supports and where its defaults or command language intentionally differ.

## Diagnose problems

- [Troubleshooting](https://getred.dev/docs/troubleshooting.md): Use Red's focused checks to separate installation, configuration, runtime asset, language-server, Agent, keyboard, and recovery problems.

## Optional background and releases

- [Complete documentation](https://getred.dev/llms-full.txt): Every guide above in a single Markdown file.
- [Use these docs with your agent](https://getred.dev/docs/getting-started/agent-docs.md): Give a coding agent Red's documentation as Markdown through the llms.txt index, per-page exports, and your agent's instruction file.
- [Release notes](https://getred.dev/releases): Published Red releases and compatibility changes.