scaffold AGENTS.md

Project instructions for Scaffold, including its checks, release process, and rules for completing work. Scaffold is a software project with Bash and TypeScript quality gates.

In plain words
What is it for?
Use them when changing Scaffold, running its validation and tests, preparing a release, updating user-facing documentation, or publishing a version.
Why use it?
They clarify which commands to run and how releases must be prepared, reducing missed checks or incorrect publishing steps.

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

Made for: Codex, OpenCode.

Per session 626 This file is loaded in full into every session.
When invoked 626 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.00626 $0.00626
Opus 5 $0.00313 $0.00313
Sonnet 5 $0.00125 $0.00125
Haiku 4.5 $0.00063 $0.00063

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

Security

Grade A, and why

scaffold 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 · 60 lines

How it starts

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

Agent Instructions

This repository does not use Beads for repo task tracking. Do not use the Beads CLI when working on Scaffold itself.

Quick Reference

make check            # Run bash quality gates (lint + validate + test + eval)
make check-all        # Run all quality gates (bash + TypeScript); full pre-push gate
git status -sb        # Inspect local state quickly
git pull --rebase     # Rebase onto latest remote state
git push              # Publish local commits

Scaffold Releases

When releasing Scaffold itself, follow docs/architecture/operations-runbook.md instead of the generic /scaffold:release guidance.

  • Update CHANGELOG.md and README.md when user-facing behavior, install or upgrade steps, migration instructions, or command semantics changed.
  • Merge the release-prep commit/PR to main before tagging.
  • Tag merged main as vX.Y.Z and push the tag.
  • Create the GitHub release.
  • publish.yml uses BOTH the GitHub OIDC trusted-publisher config (provenance signing only) AND the NPM_TOKEN repo secret (the actual registry PUT). As of v3.28.0 the OIDC token alone does NOT authorize the publish — if npm publish fails with auth errors, fix the NPM_TOKEN secret per docs/architecture/operations-runbook.md §4.2a, not the trusted-publisher config.
  • Verify the publish.yml and update-homebrew.yml workflows succeeded so users can update via npm update -g @zigrivers/scaffold and brew upgrade scaffold.

Landing the Plane (Session Completion)

When ending a work session, you MUST complete ALL steps below. Work is NOT complete until git push succeeds.

MANDATORY WORKFLOW:

  1. File follow-up work - Record anything still needing work in the current tracker or leave explicit handoff notes
  2. Run quality gates (if code changed) - Run make check-all as the full gate before push/hand-off
  3. Update follow-up status - Make sure remaining work is reflected in the current tracker or handoff
  4. PUSH TO REMOTE - This is MANDATORY:
    git pull --rebase
    git push
    git status  # MUST show "up to date with origin"
    
  5. Clean up - Clear stashes, prune remote branches
  6. Verify - All changes committed AND pushed
  7. Hand off - Provide context for next session

Read the full file on GitHub · 60 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 · 60 lines · 626 tokens per session scan A 0d94a5a3df1f

Subscribe to this mod's changes

scaffold AGENTS.md is an instructions file published in the GitHub repository zigrivers/scaffold (5 stars, last pushed yesterday), licensed MIT. It adds 626 tokens to every session, about $0.0031 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.