What is gh-attach AGENTS.md?

Project instructions for Addono/gh-attach, a TypeScript tool with command-line, upload, and MCP server components. They describe how to build, test, lint, format, and organize the project.

Use them when changing, testing, documenting, or reviewing this project, including its CLI, upload strategies, GitHub integration, and MCP server.

They give the agent the project's required commands, file structure, coding rules, error types, and testing expectations.

How Addono/gh-attach configures Codex and OpenCode

Reuse

Borrowing it

Nothing to install: this file belongs to Addono/gh-attach. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/Addono/gh-attach/main/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/Addono/gh-attach

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/addono/gh-attach/agents-md/github.svg)](https://agentmods.dev/instructions/addono/gh-attach/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/addono/gh-attach/agents-md"><img src="https://agentmods.dev/badge/instructions/addono/gh-attach/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/addono/gh-attach/agents-md"><img src="https://agentmods.dev/badge/instructions/addono/gh-attach/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 312 This file is loaded in full into every session.

When invoked 312 The same file — it is already loaded in full.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

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.

Model	Per session	Once invoked
Fable 5.1	$0.00312	$0.00312
Opus 5.5	$0.00125	$0.00125
Sonnet 5.5	$0.00062	$0.00062
Haiku 4.5	$0.00031	$0.00031

Measured 2mo ago against content hash 84cc7cff364a, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

gh-attach 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 2mo 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 · 43 lines

What it actually says

Build & Run

npm run build        # Build with tsup (ESM output to dist/)
npm run dev          # Build in watch mode

Validation

npm test             # Run unit + integration tests (vitest)
npm run test:unit    # Unit tests only
npm run test:e2e     # E2E tests (needs E2E_TESTS=true + secrets)
npm run typecheck    # TypeScript strict mode check
npm run lint         # ESLint
npm run format:check # Prettier

Project Structure

src/
  core/         # Upload strategies, types, validation
  cli/          # Commander.js CLI entry point
  mcp/          # MCP server (stdio + HTTP)
test/
  unit/         # Unit tests (mirrors src/ structure)
  integration/  # Integration tests with msw HTTP mocking
  e2e/          # End-to-end tests against real GitHub
  fixtures/     # Shared test fixtures
openspec/
  specs/        # Source-of-truth specifications
  changes/      # Active change proposals

Conventions

Conventional Commits (feat:, fix:, test:, docs:, etc.)
Strict TypeScript (no any)
ESM-only output
All public APIs have JSDoc comments
Error hierarchy: GhAttachError → AuthenticationError | UploadError | ValidationError

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.

2mo ago First seen · 43 lines · 312 tokens per session scan A 84cc7cff364a

Subscribe to this mod's changes

gh-attach AGENTS.md is an instructions file published in the GitHub repository Addono/gh-attach (5 stars, last pushed 3d ago), licensed MIT. It adds 312 tokens to every session, about $0.0012 per session on Opus 5.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.

gh-attach AGENTS.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
gh-attach AGENTS.mdAddono/gh-attach	Instructions file	5	3d ago	MIT	A	312	Codex, OpenCode
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	yesterday	MIT	A	7,461	Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	yesterday	MIT	A	4,680	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	5,516	GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	3,093	GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harness	Instructions file	274k	2d ago	MIT	A	4,313	Codex, OpenCode

gh-attach: Instructions file for Codex