brigade AGENTS.md

A contributor guide for Brigade, a TypeScript runtime that coordinates multiple AI agents through a WebSocket service and smaller client programs. It explains the project’s technology choices, commands, storage location, naming rules, and repository layout.

In plain words
What is it for?
Use it when developing Brigade features, running its build or tests, navigating the repository, handling stored state, or writing user-facing documentation.
Why use it?
It gives both people and AI coding agents the conventions needed to make safe, consistent changes. This reduces mistakes involving the required Node and npm versions, TypeScript build, tests, state files, and product naming.

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

Made for: Codex, OpenCode.

Per session 3,380 This file is loaded in full into every session.
When invoked 3,380 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.03380 $0.03380
Opus 5 $0.01690 $0.01690
Sonnet 5 $0.00676 $0.00676
Haiku 4.5 $0.00338 $0.00338

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

Security

Grade A, and why

brigade 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 2d 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 · 263 lines

How it starts

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

AGENTS.md — Working in the Brigade codebase

This guide is for humans and AI coding agents contributing to Brigade. It covers the layout, the commands, the conventions you must follow, and the recipes for common changes. Read it before you touch the tree.

For user-facing docs see README.md. For the release flow see docs/RELEASING.md.


What Brigade is

A single-operator, multi-agent AI-crew runtime written in TypeScript. It runs as a headless WebSocket gateway (the state-holding daemon) with thin clients (a chat TUI, connect, channel adapters). It is built on the pi SDK (@earendil-works/pi-agent-core + @earendil-works/pi-ai + @earendil-works/pi-coding-agent + @earendil-works/pi-tui, pinned exact at 0.79.9) and adds product layers on top: memory, skills, sub-agents, tools, an org hierarchy, channels, cron, an extension SDK, and a dual-mode storage layer.

  • Stack: TypeScript (strict), ESM, Node ≥ 22.12, npm (never pnpm).
  • Build: tscdist/. No bundler.
  • Tests: Node's built-in node:test, run via tsx.
  • State: everything under ~/.brigade/ (override: BRIGADE_STATE_DIR).

Naming & brand conventions (MUST follow)

  • The product is Brigade. In code, comments, copy, CLI help, error messages, env vars, daemon labels, and docs, refer to the agent SDK only as pi / @earendil-works/pi-coding-agent. Do not name other third-party AI agent projects.
  • Never commit secrets, real personal data (names, phone numbers, emails), or local absolute paths. Use placeholders (+1 555 010 0001, /path/to/project).
  • The mascot is 🦁 the Pride. No other animal/symbol.
  • templates/workspace/ holds default persona files and is off-limits: behavioural fixes go in code, never in template content.
  • No Co-Authored-By trailers on commits.

Daemon labels (don't rename): macOS launchd com.brigade.gateway, Linux systemd brigade-gateway, Windows Task Scheduler BrigadeGateway.

Read the full file on GitHub · 263 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. 2d ago First seen · 263 lines · 3,380 tokens per session scan A d30fe42714da

Subscribe to this mod's changes

brigade AGENTS.md is an instructions file published in the GitHub repository spinabot/brigade (3,342 stars, last pushed yesterday), licensed MIT. It adds 3,380 tokens to every session, about $0.0169 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.