# Use these docs with your agent

Canonical HTML: [Use these docs with your agent](https://getred.dev/docs/getting-started/agent-docs). Website source: `b212874eefaf200143affa21c770fbb8855a4f5c`. Documented Red release: v0.9.1. Installer source: `b86a2ca4b92e9547d3b174910c82db8a259f5171`.

Give a coding agent Red's documentation as Markdown through the llms.txt index, per-page exports, and your agent's instruction file.

<a id="start-your-agent-at-the-index"></a>

## Start your agent at the index

Every documentation page is also published as Markdown. Agents can read it directly, without navigation, scripts, or HTML to strip. Point an agent at the index first:

| URL                                                            | What it returns                                                                                                           |
| -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| [`/llms.txt`](https://getred.dev/llms.txt)                     | Every guide, grouped by task, with a one-line description and a Markdown link. Start here.                                |
| [`/llms-full.txt`](https://getred.dev/llms-full.txt)           | Every guide in one file, for tools that load documentation in a single request.                                           |
| [`/docs.md`](https://getred.dev/docs.md)                       | The documentation overview.                                                                                               |
| `/docs/<guide>.md`                                             | Any guide. Add `.md` to the address of the page you're reading.                                                           |
| [`/docs/for-agents.md`](https://getred.dev/docs/for-agents.md) | Instructions written for agents: check the installed version, choose the right configuration layer, and validate changes. |

<a id="ask-your-agent-to-read-it"></a>

## Ask your agent to read it

Paste a prompt like this into Codex, Claude Code, or another coding agent:

```text
Read https://getred.dev/llms.txt and follow its links to the guides you need.
Check `red --version` first and follow each guide's minimum-version notes.
Then help me: <describe the task>
```

<a id="add-red-to-your-agents-instructions"></a>

## Add Red to your agent's instructions

To make the docs available in every session, add a short note to the instruction file your agent reads. Codex reads `AGENTS.md` and Claude Code reads `CLAUDE.md`, from the project or from your home directory.

`AGENTS.md`:

```text
## Red editor

When installing, configuring, or extending the Red editor, read
https://getred.dev/llms.txt first and fetch the Markdown guides it links to.
Check `red --version` before applying instructions.
```

In Cursor, type `@Docs`, choose **Add new doc**, and enter `https://getred.dev/llms.txt`.

<a id="request-markdown-from-any-docs-url"></a>

## Request Markdown from any docs URL

Documentation URLs also return Markdown when the client asks for it. Tools that send `Accept: text/markdown` get the export from the regular address:

```shell
curl -H 'Accept: text/markdown' https://getred.dev/docs/plugins/json-rpc
```

On each page, **Copy page** copies its Markdown for pasting into a chat. The menu next to it opens the page in ChatGPT or Claude.

<a id="how-the-markdown-stays-current"></a>

## How the Markdown stays current

The exports are generated from these pages every time the site is built, and the build fails if a link, anchor, or code example doesn't survive the conversion. Each export names its HTML page, the website revision it came from, and the Red release it documents.

When your agent configures or extends Red, have it read [For coding agents](https://getred.dev/docs/for-agents.md), which is written for agents rather than people.