agentsmd AGENTS.md

Repository instructions for agents working on agentsmd, a Go command-line program that maintains AI coding-agent instruction files such as AGENTS.md, CLAUDE.md, and GEMINI.md.

In plain words
What is it for?
Developing the CLI, running its tests and static checks, formatting Go files, and checking instruction references with its doctor and analyze commands.
Why use it?
They provide the commands and conservative rules needed to build, test, format, and validate the program reliably.

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

Made for: Codex, OpenCode.

Per session 521 This file is loaded in full into every session.
When invoked 521 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.00521 $0.00521
Opus 5 $0.00260 $0.00260
Sonnet 5 $0.00104 $0.00104
Haiku 4.5 $0.00052 $0.00052

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

Security

Grade A, and why

agentsmd 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 yesterday.

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 · 74 lines

How it starts

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

AGENTS.md

Guidance for AI coding agents working in this repository.

agentsmd is a zero-dependency Go CLI that keeps AI agent instruction files (AGENTS.md, CLAUDE.md, GEMINI.md) healthy: it generates a grounded AGENTS.md from repository facts, validates every command and file reference, audits quality and token cost, and bridges CLAUDE.md/GEMINI.md to AGENTS.md.

Commands

All commands run from the repository root.

Build

go build -o agentsmd .

Testing

go test ./...

Lint & static analysis

go vet ./...
gofmt -l .

Try it end to end

go run . doctor .
go run . analyze .

Code style

  • Formatting is enforced by gofmt: run gofmt -w on touched files.
  • Standard library only — no third-party dependencies. Detection that needs a parser (package.json is JSON) uses encoding/json; TOML/YAML uses the pragmatic line readers in internal/analyze/tomlish.go.
  • Keep validation conservative: when the engine is not certain a reference is broken, it must stay silent. False positives destroy trust in check.
  • Errors go to stderr with exit code 1; findings are data (see validate.Finding).

Testing notes

Tests are table-driven and build fixture repositories in t.TempDir(); nothing reads the network or the host filesystem outside the fixture.

  • internal/analyze_test.go — toolchain detection per ecosystem
  • internal/mdutil_test.go — markdown command/path extraction
  • internal/validate_test.go — the conservative-checking contract
  • internal/cli_test.go — end-to-end: builds the binary and runs init → sync → doctor

Run a single package with go test ./internal/validate/.

Gotchas & conventions

  • This tool parses its own AGENTS.md in CI (the dogfood job) — every command documented here must actually work, go run . form included.
  • Agentsmd supports flags after positional arguments (e.g. agentsmd tokens . --json) via normalizeArgs in internal/cli/cli.go; keep new flags listed in boolFlags/valueFlags or they will not parse.
  • Windows path handling: always filepath.Join / filepath.ToSlash, never "/".

Read the full file on GitHub · 74 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. yesterday First seen · 74 lines · 521 tokens per session scan A d467c00d1098

Subscribe to this mod's changes

agentsmd AGENTS.md is an instructions file published in the GitHub repository youwei792/agentsmd (1 stars, last pushed yesterday), licensed MIT. It adds 521 tokens to every session, about $0.0026 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-31.