All integrations

AGENTS.md

Codex CLI · Aider · Zed · any tool that reads AGENTS.md.

LiveEditorchirp login
progress (primary) Live Activity preview
any AGENTS.md tool

AGENTS.md is the emerging cross-vendor convention for "context an agent reads on every turn" - the same role `.cursorrules` plays in Cursor, but portable. Codex CLI reads it, Aider reads it, Zed's agent reads it, more tools are adding support every month. Chirp ships an AGENTS.md that covers the same ground as `.cursorrules` but written in tool-agnostic prose.

Drop one file at the repo root and any AGENTS.md-aware tool can wire Chirp into your project. The file teaches the agent: (1) when Chirp is the right tool (long-running command, CI, training), (2) how to invoke it (the CLI, the SDKs, the schemas), (3) what *not* to use it for (one-shot quick commands).

Prerequisites

  • Any AGENTS.md-aware coding tool - currently Codex CLI, Aider, Zed, plus anything that follows the convention.
  • A Chirp account paired via `chirp login`.

Setup

  1. 1

    Pair the CLI

    chirp login - opens a browser, drops credentials at ~/.chirp/credentials. Any tool that shells out from your project picks this up automatically.

    shell
    chirp login
  2. 2

    Drop AGENTS.md at the repo root

    Single file, ~150 lines of structured Markdown. Sections cover Chirp's CLI, SDKs, schema vocabulary, and a few "when to call this" / "when not to" examples. Safe to commit.

    shell
    curl -o AGENTS.md https://chirpapp.dev/agent-skill/AGENTS.md
  3. 3

    (Optional) Merge with an existing AGENTS.md

    If your repo already has AGENTS.md (e.g. for Codex), append Chirp's section instead of overwriting:

    shell
    curl -fsSL https://chirpapp.dev/agent-skill/AGENTS.md >> AGENTS.md
  4. 4

    Use any AGENTS.md-aware agent

    Open the project in Codex / Aider / Zed / etc. Ask in plain English: "send me a notification when the build finishes" or "page my phone if these tests fail." The agent reads AGENTS.md, picks the right Chirp surface, and wires it in.

What you’ll see

No card from the file itself - the cards appear because the agent wires Chirp into your scripts. The chosen surface (CLI wrap, SDK call, CI step) varies by what the agent edits.

Troubleshooting

My agent doesn't seem to read AGENTS.md.
AGENTS.md adoption is uneven. Codex CLI reads it natively; Aider reads it as of 0.50+; Zed reads it from 0.140+. For older versions, copy AGENTS.md to the agent-specific filename (.cursorrules, .windsurfrules, CLAUDE.md) instead.
I want different AGENTS.md content per directory.
Most agents support nested AGENTS.md - agent reads root + nearest ancestor. Use a root file with project-wide guidance and per-directory files for component-specific instructions.
Browse all integrations