shippie: Instructions file for Codex

AGENTS.md

shippie AGENTS.md is an instructions file for Codex, OpenCode from mattzcarey/shippie. It costs 993 tokens per session, scanned A, original, MIT.

Repository instructions for Shippie, a prebuilt code-review agent that runs in automated development environments and can report comments to GitHub.

In plain words
What is it for?
Use them when changing review workflows, diff handling, GitHub reporting, agent tools, or Vitest tests.
Why use it?
They show where review logic lives and how code changes should be built, tested, configured, and reported.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md. Also seen: mentions CLAUDE.md; mentions AGENTS.md.

This is mattzcarey/shippie's own configuration. It tells Codex and OpenCode how to work on shippie itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything shippie configures →

About the project

mattzcarey/shippie is an extensible code-review agent that examines code changes with developer tools and posts focused review comments. Teams use it to detect issues such as exposed secrets, inefficient code, bugs, and unhandled edge cases in pull-request workflows.

mattzcarey/shippie · 2,496 stars · on GitHub · shippie.dev

Reuse

Borrowing it

Nothing to install: this file belongs to mattzcarey/shippie. 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/mattzcarey/shippie/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/mattzcarey/shippie

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.

agentmods badge for shippie AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/mattzcarey/shippie/agents-md.svg)](https://agentmods.dev/instructions/mattzcarey/shippie/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/mattzcarey/shippie/agents-md"><img src="https://agentmods.dev/badge/instructions/mattzcarey/shippie/agents-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 993 This file is loaded in full into every session.
When invoked 993 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.

ModelPer sessionOnce invoked
Fable 5.1 $0.00993 $0.00993
Opus 5 $0.00496 $0.00496
Sonnet 5 $0.00199 $0.00199
Haiku 4.5 $0.00099 $0.00099

Measured 9d ago against content hash 7d1bc284941a, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-08, from the pricing page.

Security

Grade A, and why

shippie 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 9d 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 · 52 lines

How it starts

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

Repository Guidelines

Shippie is a prebuilt code-review agent built on flue (which runs the agent loop on "pi"). It ships as a flue project and as a GitHub Action, and runs anywhere flue deploys (Node, Cloudflare, GitHub Actions, GitLab CI).

Project Structure

  • flue.config.tsdefineConfig({ target: 'node' }).
  • src/agents/reviewer.ts — the review agent (createAgent): model, local() sandbox, instructions, and the suggest_change tool.
  • src/workflows/review.ts — the one-shot review workflow (run({ init, payload, env })); also exports route so the built server can serve POST /workflows/review.
  • src/tools/suggest-change.tsdefineTool for inline review comments.
  • src/review/config.ts (resolve config from payload/env), diff.ts (git diff + parsing), instructions.ts (review prompt + AGENTS.md/CLAUDE.md injection), context.ts (prompt builder), constants.ts, prompt/fileInfo.ts, utils/filterFiles.ts.
  • tests/ — vitest specs (*.test.ts), mirroring the src/ layout (kept out of src/ so the package code stays clean).
  • src/github/reporter.ts — posts inline comments + summary to GitHub (Octokit) or to a local file.
  • src/mcp/connect.ts — connects remote MCP servers from config.
  • src/common/ — shared types.ts and formatting/summary.ts.
  • action.yml — composite GitHub Action. docs/ — user docs (docs/flue-migration.md is the refactor log).

Build, Test, and Development Commands

  • Install: npm install (Node >= 22.19 required).
  • Lint + format: npm run check (oxlint + oxfmt). Auto-fix: npm run check:fix.
  • Type-check: npm run check:types (tsc --noEmit).
  • Build: npm run build (flue build --target nodedist/server.mjs).
  • Run a review locally: npm run review (flue run review --target node); reviews staged changes and writes to .shippie/review/. Pass --payload '{"platform":"local"}' explicitly if needed.
  • Run the built server: npm start (node dist/server.mjs), then POST /workflows/review?wait=result.
  • Tests: npm test (vitest).

Read the full file on GitHub · 52 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. 9d ago First seen · 52 lines · 993 tokens per session scan A 7d1bc284941a

Subscribe to this mod's changes

shippie AGENTS.md is an instructions file published in the GitHub repository mattzcarey/shippie (2,496 stars, last pushed 5d ago), licensed MIT. It adds 993 tokens to every session, about $0.0050 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

next.js AGENTS.md

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

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,153 tokens

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

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

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,469 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