alloy AGENTS.md

A quick-start guide for coding agents working in the Alloy repository, covering safety rules, setup, commands, examples, documentation, and testing profiles.

In plain words
What is it for?
It helps agents create the development environment, run fast or full checks, execute tests, lint and format code, type-check it, and run provider examples.
Why use it?
It reduces setup mistakes and keeps changes small, reversible, tested, formatted, and free of secrets.

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/lydakis/alloy/agents-md
Clone the repo
git clone --depth 1 https://github.com/lydakis/alloy

Made for: Codex, OpenCode.

Per session 2,397 This file is loaded in full into every session.
When invoked 2,397 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.02397 $0.02397
Opus 5 $0.01198 $0.01198
Sonnet 5 $0.00479 $0.00479
Haiku 4.5 $0.00240 $0.00240

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

Security

Grade A, and why

alloy 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 · 140 lines

How it starts

The opening of the file, as written. The whole thing — 140 lines — stays where its author put it; the contents beside it link to each section on GitHub.

AGENTS — Quick Guide

This file guides coding agents working in this repository. It applies to the entire repo. Deeper AGENTS.md files may further specialize instructions and take precedence within their subtrees.

Scope & Expectations

  • Keep changes minimal, focused, and reversible; avoid broad refactors.
  • Do not alter public API without explicit instruction; prefer additive changes.
  • Never commit secrets (.env, API keys). Verify .gitignore is respected.
  • Follow style tools; let formatters fix whitespace vs. hand edits.

One‑Time Setup

  • Create env: python -m venv .venv && source .venv/bin/activate
  • Install dev deps: pip install -e '.[dev]'
  • Install hooks: pre-commit install

Core Commands

  • Quick check: make ci-fast (lint + typecheck + focused tests, coverage >= 80)
  • Full local CI: make ci (lint, typecheck, tests)
  • Tests: make test (filter: pytest -k <pattern> -q)
  • Lint/format: make lint / make format then make precommit
  • Typecheck: make typecheck
  • Examples (fake backend): make examples-quick
  • Provider examples (need keys): make examples-openai|anthropic|gemini|ollama
  • Docs: make docs-serve (live) or make docs-build (strict)
  • Release (trusted publishing): create and push a tag, see make release

Testing Profiles

  • Unit/contracts/providers: make ci-fast
  • Integration (requires keys): make itest or provider‑specific make itest-openai|anthropic|gemini|ollama
  • Skip integ locally: ALLOY_IT_MODEL=none pytest -q
  • Smoke examples without keys: make smoke-examples (uses ALLOY_BACKEND=fake)

Environment Cheatsheet

  • Default model: gpt-5-mini (override with ALLOY_MODEL)
  • Useful vars: ALLOY_TEMPERATURE, ALLOY_MAX_TOKENS, ALLOY_SYSTEM/ALLOY_DEFAULT_SYSTEM, ALLOY_RETRY, ALLOY_MAX_TOOL_TURNS, ALLOY_EXTRA_JSON
  • Provider keys: OPENAI_API_KEY, ANTHROPIC_API_KEY, GOOGLE_API_KEY; use .env locally and dotenv -f .env run -- <cmd>

Code & Docs Style

  • Python: PEP 8 + type hints; 4‑space indent. Run ruff and black.
  • Docstrings: concise, imperative; include non‑obvious types.
  • Imports: re‑export public API from alloy/__init__.py; import via from alloy import ... in code/docs.
  • Decorators: bare @command/@tool when no options; @command(...)/@tool(...) when passing options.

Read the full file on GitHub · 140 lines

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 · 140 lines · 2,397 tokens per session scan A d1c39f348d34

Subscribe to this mod's changes

alloy AGENTS.md is an instructions file published in the GitHub repository lydakis/alloy (18 stars, last pushed 3mo ago), licensed MIT. It adds 2,397 tokens to every session, about $0.0120 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.

Related

Other instructions, from other repositories

waku-agent CLAUDE.md

Instructions for ShenSeanChen/waku-agent, covering waku-agent — working conventions, architecture map (file ↔ diagram box), rules and commands.

ShenSeanChen/waku-agent · 2,548 tokens

kungfu copilot-instructions.md

Copilot instructions for kungfu-systems/kungfu: Read and follow AGENTS.md before proposing or running changes. It is the shared agent router for this repository, including the canonical Shifu development and build entrypoint.

kungfu-systems/kungfu · 45 tokens

aeon CLAUDE.md

Instructions for aeonfun/aeon, covering aeon, how aeon works, strategy, voice and soul file hierarchy (read in this order).

aeonfun/aeon · 3,720 tokens

CrewClaw AGENTS.md

Instructions for staruhub/CrewClaw, covering agents.md, project, boundaries (charter, 2026-07-10), commands and employee package rules.

staruhub/CrewClaw · 762 tokens

Agent-Worlds CLAUDE.md

Instructions for hjl2004-10/Agent-Worlds, covering ai夸父 开发规范文档 (v2.0 - skill化重构), 架构总览:概念坐标系(先看这张图), 横向:子系统(业界术语 ↔ 本项目目录), 纵向:作用域分层(每个子系统内部都按此三层) and 正交二维(横×纵 = 网格,不是树).

hjl2004-10/Agent-Worlds · 7,125 tokens

nanobot CLAUDE.md

Claude Code instructions for HKUDS/nanobot, a project described as: Ultra-lightweight, open-source, self-hosted personal AI agent framework in Python with WebUI, tools, memory, MCP, multi-agent workflows, automation, and chat apps.

HKUDS/nanobot · 5 tokens