source-agents AGENTS.md

Repository instructions for a TypeScript command-line project with a text-based interface. They document its folders, commands, code style, and testing expectations.

In plain words
What is it for?
Use them when editing the project, especially when finding source files, installing dependencies, running type checks, building the command-line tool, or checking contribution conventions.
Why use it?
They give coding agents the project-specific rules they need to make changes that fit the existing codebase and pass its checks.

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

Made for: Codex, OpenCode.

Per session 582 This file is loaded in full into every session.
When invoked 582 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.00582 $0.00582
Opus 5 $0.00291 $0.00291
Sonnet 5 $0.00116 $0.00116
Haiku 4.5 $0.00058 $0.00058

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

Security

Grade A, and why

source-agents 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 3d 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 · 46 lines

How it starts

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

Repository Guidelines

Project Structure & Modules

  • Source lives in src/ with ESM TypeScript.
    • CLI entry: src/cli.tsx → built to dist/cli.js.
    • UI: src/components/ (Ink + React).
    • Logic: src/services/ (scanner, analyzer, executor).
    • Helpers: src/utils/, shared types in src/types/.
  • Build output in dist/ (committed artifacts are not expected).

Build, Test, and Dev

  • Install: bun install
  • Dev TUI: bun run dev --root ~/projects (use --auto, --dry-run, --exclude as needed).
  • Type‑check: bun run type-check
  • Build: bun run build (emits ESM to dist/).
  • Start built CLI: node dist/cli.js --help
  • CI runs type‑check, build, and a smoke CLI help check.

Coding Style & Naming

  • TypeScript strict, ESM imports, 2‑space indent.
  • Components: PascalCase files (ResultsTable.tsx, ActionMenu.tsx).
  • Services/Utils/Types: lowercase filenames (scanner.ts, paths.ts, index.ts).
  • Use camelCase for variables/functions, UPPER_SNAKE_CASE for constants, named exports preferred.
  • Keep functions small and pure in services/; UI logic stays in components/.

Testing Guidelines

  • No formal test suite yet; contributions welcome.
  • Prefer Vitest for unit tests; place tests under src/**/__tests__ with *.test.ts.
  • Target high‑value coverage for services/ (scanner/analyzer/executor). Aim for 80%+ on touched files.
  • Add lightweight CLI smoke tests if feasible.

Commit & Pull Requests

  • Use Conventional Commits: feat:, fix:, docs:, refactor:, chore:.
  • Scope clearly and write imperative, present‑tense summaries (≤72 chars).
  • PRs should include: summary, motivation, screenshots or sample CLI output, steps to verify, and linked issues.
  • Keep diffs focused; update README or this file if behavior changes.

Security & Configuration

  • Requires Node 18+ and Bun 1.1+. ESM only.
  • Use --dry-run for potentially destructive actions; limit scans with --root.
  • Default excludes: node_modules, .git, dist, common build caches. Add extras via --exclude.

Read the full file on GitHub · 46 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. 3d ago First seen · 46 lines · 582 tokens per session scan A d676f74df68b

Subscribe to this mod's changes

source-agents AGENTS.md is an instructions file published in the GitHub repository iannuttall/source-agents (124 stars, last pushed 10mo ago), licensed MIT. It adds 582 tokens to every session, about $0.0029 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

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,345 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

next.js AGENTS.md

Instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens