CodeBoarding-action AGENTS.md

Repository instructions for CodeBoarding-action, a GitHub Action that reviews pull requests with architecture diagrams or updates a stored architecture baseline. They cover releases, engine-version changes, protected tests, and commit-message rules.

In plain words
What is it for?
Use them when modifying the action, updating the CodeBoarding engine pin, checking provider support, changing protected workflows, or preparing a conventional-commit release.
Why use it?
They explain how changes affect the action, its separately maintained analysis engine, its pinned versions, and its automated release process.

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

Made for: Codex, OpenCode.

Per session 1,188 This file is loaded in full into every session.
When invoked 1,188 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.01188 $0.01188
Opus 5 $0.00594 $0.00594
Sonnet 5 $0.00238 $0.00238
Haiku 4.5 $0.00119 $0.00119

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

Security

Grade A, and why

CodeBoarding-action 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 · 98 lines

How it starts

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

AGENTS.md — CodeBoarding-action

This repo is a GitHub Action with two modes, selected by the mode input:

  • mode: review (default): analyzes a PR with the CodeBoarding engine and posts a Mermaid diagram of the added, modified, and removed components as a PR comment (runs on pull_request / issue_comment).
  • mode: sync: on push to a branch, regenerates the architecture and commits the versioned baseline (.codeboarding/analysis.json + rendered markdown) back to the branch, so review mode always diffs against a current baseline.

The action is a thin orchestration wrapper, not the analysis engine: the engine (CodeBoarding/CodeBoarding) is a separate repo checked out at runtime and pinned to a release in action.yml. scripts/engine_adapter.py is the CLI adapter into it (no analysis logic lives there). Engine changes reach users only when that pin is bumped and a new action release ships.

Bumping the engine pin

scripts/action/supported-providers.json mirrors the pinned release's LLM_PROVIDERS. Credentials are validated before the engine is installed — that is what makes a misconfigured run fail in seconds instead of a minute — so the action cannot ask the engine at run time and keeps this copy instead.

When you change the codeboarding== pin in action.yml, update that file in the same commit: its engine field, and any provider whose selection variables changed. tests/test_provider_table_drift.py runs in the core-compatibility CI job and fails when they disagree. Adding a provider also means adding its <name>_api_key input to action.yml; tests/test_action_inputs.py checks that.

Protected tests

Some tests encode a behavioural contract that is expensive to rediscover once lost. They are marked with a PROTECTED TEST header naming what they protect.

No agent, assistant, or automated tool may edit, weaken, skip, rename or delete a protected test — not even to make a build pass. Only a human may change one, and only after explicitly saying so in that conversation. A request to "fix the failing tests" is not that consent.

Read the full file on GitHub · 98 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 · 98 lines · 1,188 tokens per session scan A 50f827898946

Subscribe to this mod's changes

CodeBoarding-action AGENTS.md is an instructions file published in the GitHub repository CodeBoarding/CodeBoarding-action (11 stars, last pushed 4d ago), licensed MIT. It adds 1,188 tokens to every session, about $0.0059 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

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

buildNext

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

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

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

spec-kit 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,040 tokens

langchain 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