# Use Red

Canonical HTML: [Use Red](https://getred.dev/docs). Website source: `b212874eefaf200143affa21c770fbb8855a4f5c`. Documented Red release: v0.9.1. Installer source: `b86a2ca4b92e9547d3b174910c82db8a259f5171`.

Install the editor, complete a short first session, then move into the parts of Red you need.

<a id="start-here"></a>

## Start here

### Install Red

**macOS + Linux**

```shell
curl -fsS https://getred.dev/install.sh | sh
```

**Windows**

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

**Homebrew**

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

The install scripts verify the release checksum and run `red --self-check`. [Other install methods](https://getred.dev/docs/getting-started/install.md)

### Open a project

```shell
red -r path/to/project
```

Edit and save a file, then find commands when you need them. [Your first session](https://getred.dev/docs/getting-started/first-session.md)

<a id="agent-docs"></a>

## Point your agent at the docs

Every page is also plain Markdown. Start a coding agent at the index, or [add Red to its instructions](https://getred.dev/docs/getting-started/agent-docs.md) once. Agents that configure or extend Red should read [For coding agents](https://getred.dev/docs/for-agents.md).

- [`getred.dev/llms.txt`](https://getred.dev/llms.txt)
- [`getred.dev/docs.md`](https://getred.dev/docs.md)

<a id="browse-docs"></a>

## Browse by task

### Editor

Files, editing, search, windows, language tools, and Git.

- [Navigate and edit](https://getred.dev/docs/editor/navigation.md)
- [Search and replace](https://getred.dev/docs/editor/search.md)
- [Buffers and windows](https://getred.dev/docs/editor/windows.md)
- [Language tools](https://getred.dev/docs/languages.md)
- [TypeScript and ESLint](https://getred.dev/docs/languages/typescript-eslint.md)
- [Git](https://getred.dev/docs/git.md)

### Agent

Codex setup, full Agent work, inline assist, review, and history.

- [Agent and inline assist](https://getred.dev/docs/agent.md)

### Customize

Configuration, keybindings, themes, plugins, and Husk.

- [Configuration](https://getred.dev/docs/configuration.md)
- [Keybindings](https://getred.dev/docs/keybindings.md)
- [Themes](https://getred.dev/docs/themes.md)
- [Plugins](https://getred.dev/docs/plugins.md)
- [JSON-RPC plugins](https://getred.dev/docs/plugins/json-rpc.md)
- [Husk](https://getred.dev/docs/husk.md)

### Sessions and reference

Detach, recovery, command-line options, Vim behavior, and problem diagnosis.

- [Detach and recover](https://getred.dev/docs/sessions.md)
- [Command line](https://getred.dev/docs/reference/cli.md)
- [Vim compatibility](https://getred.dev/docs/reference/vim.md)
- [Troubleshooting](https://getred.dev/docs/troubleshooting.md)