From 8f32ae0f6eb0fe73189aa505e00da170e8d1f2fc Mon Sep 17 00:00:00 2001 From: Hamza Ali Shahjahan <191920295+hamza-ali-shahjahan@users.noreply.github.com> Date: Thu, 9 Jul 2026 15:48:17 +0500 Subject: [PATCH] docs: add JetBrains Junie, Amp, and Jules support (native AGENTS.md readers) (#326) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: add JetBrains Junie support (native AGENTS.md reader) Junie reads AGENTS.md from the project root natively (per JetBrains' official docs), so ponytail works zero-config in any JetBrains IDE — like CodeWhale (#124). Adds a README note + agent-portability row, and bumps the agent badge 16 -> 17. Docs-only. * docs: also add Amp and Jules support (native AGENTS.md readers) Amp (Sourcegraph) reads AGENTS.md as its primary guidance file (cwd + parents up to $HOME + global config; per ampcode.com/manual). Jules (Google) auto-reads AGENTS.md from the repo root (per jules.google/docs). Both work zero-config via the AGENTS.md this repo ships. Badge 17->19. Roo Code evaluated and excluded (archived 2026-05-15). * Merge main; correct Junie AGENTS.md note (Guidelines Path, not automatic) --------- Co-authored-by: Emeriko --- README.md | 8 +++++++- docs/agent-portability.md | 3 +++ 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b9b4be6..0a8520f 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Stars Release npm - Works with 16 agents + Works with 19 agents MIT license

@@ -255,6 +255,12 @@ GitHub Copilot CLI fallback (instruction-only mode): it reads `AGENTS.md` and `. VS Code with the Codex extension reads `AGENTS.md`, which this repo ships, so it works from the repo root with no setup (`~/.codex/AGENTS.md` makes Codex global). +JetBrains Junie can read `AGENTS.md` once you point it there in Settings → Tools → Junie → Project Settings → Guidelines Path (it is not automatic yet). This repo ships `AGENTS.md`; `.junie/guidelines.md` is Junie's legacy path. + +Amp (Sourcegraph) reads `AGENTS.md` from the working directory and parent directories up to `$HOME`, which this repo ships, so it works with no setup (`~/.config/amp/AGENTS.md` works globally). + +Jules (Google) reads `AGENTS.md` from the repository root, which this repo ships, so it picks up the ruleset with no setup. + Which files map to which agent: [Agent portability](docs/agent-portability.md). ### Uninstall diff --git a/docs/agent-portability.md b/docs/agent-portability.md index 5a61d8e..417e7fc 100644 --- a/docs/agent-portability.md +++ b/docs/agent-portability.md @@ -23,6 +23,9 @@ to load in a given agent. | CodeWhale | `AGENTS.md` | Reads `AGENTS.md` from the repo root as project instructions; also reads `CLAUDE.md` and `.claude/instructions.md` as fallbacks. Instruction-tier. | | Swival | `.swival/skills/`, `AGENTS.md` | `swival skills add https://github.com/DietrichGebert/ponytail` installs the six skills straight into `.swival/skills/`. Add `--global` to stage them in the library (`~/.config/swival/library`) first, then `swival skills add ponytail` (or `--global ponytail`) to activate per-project or everywhere. Also reads `AGENTS.md` from the repo root and `~/.config/swival/AGENTS.md` globally as instruction-tier fallback. | | VS Code + Codex extension | `AGENTS.md` | The Codex extension reads `AGENTS.md` (repo root, or `~/.codex/AGENTS.md` globally). Instruction-tier; the full Codex plugin row above adds `/ponytail` levels and hooks. | +| JetBrains Junie | `AGENTS.md` | Junie reads `AGENTS.md` once you point it there in Settings → Tools → Junie → Project Settings → Guidelines Path (not automatic yet); this repo ships `AGENTS.md`, and `.junie/guidelines.md` is Junie's legacy path. Instruction-tier. | +| Amp (Sourcegraph) | `AGENTS.md` | Amp reads `AGENTS.md` from the working directory and parent directories up to `$HOME` (plus global config like `~/.config/amp/AGENTS.md`); falls back to `AGENT.md`/`CLAUDE.md`. Instruction-tier. | +| Jules (Google) | `AGENTS.md` | Jules automatically reads `AGENTS.md` from the repository root. Instruction-tier. | | Kiro | `.kiro/steering/ponytail.md` | Steering rule; copy globally or into a project. | | Zed | `AGENTS.md` | Auto-includes `AGENTS.md` from the worktree root as one of its default rule files for the Agent Panel. Instruction-tier. | | Generic agents | `AGENTS.md` or `skills/*/SKILL.md` | Copy the compact rule file or load the skill files directly. |