elroy AGENTS.md

Project instructions for Elroy covering agent behavior, build and test commands, work tracking, reviews, and the roadmap. They require the project’s `just` commands for common development checks.

In plain words
What is it for?
Use them when running tests, builds, linting, formatting, or type checks; preparing a review; tracking work; finding commands; or updating the roadmap.
Why use it?
They give coding agents one consistent way to validate changes and record work. They also make clear which checks are required before code is ready for review.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/elroy-bot/elroy/agents-md
Clone the repo
git clone --depth 1 https://github.com/elroy-bot/elroy

Made for: Codex, OpenCode.

Per session 276 This file is loaded in full into every session.
When invoked 276 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00276 $0.00276
Opus 5 $0.00138 $0.00138
Sonnet 5 $0.00055 $0.00055
Haiku 4.5 $0.00028 $0.00028

Measured 2d ago against content hash 65119f217e1a, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

elroy AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 35 lines

What it actually says

Agent Instructions for Elroy

Build and Test Commands

IMPORTANT: This project uses just as a command runner. Always use just commands instead of running build/test tools directly.

Tracking work

Common Commands

  • Run tests: just test (NOT pytest or python -m pytest)
  • Run specific test: just test <test_path>
  • Build: just build (NOT python -m build or similar)
  • Lint: just lint
  • Format: just format

Finding Available Commands

Run just --list to see all available commands for this project.

Review guidelines

Use CODE_REVIEW.md as the source of truth for code review expectations in this repository.

During review:

  • Apply the role, dependency, and validation rules defined in CODE_REVIEW.md
  • Do not duplicate or invent competing review standards in review comments
  • Treat just lint, just typecheck, and just test as required validation before code is ready for review. Do NOT ignore failures even if they are pre-existing

Project Roadmap

Reference ROADMAP.md for current priorities, and update it when completing roadmap items or adding new ones.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 35 lines · 276 tokens per session scan A 65119f217e1a

Subscribe to this mod's changes

elroy AGENTS.md is an instructions file published in the GitHub repository elroy-bot/elroy (59 stars, last pushed 3mo ago), licensed Apache-2.0. It adds 276 tokens to every session, about $0.0014 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.