beacon-docs: Instructions file for Codex

AGENTS.md

beacon-docs AGENTS.md is an instructions file for Codex, OpenCode from Juliocbm/beacon-docs. It costs 1,189 tokens per session, scanned A, original, MIT.

A documentation guide for beacon-docs that defines where project documents belong, how they are named, and how their status is recorded. It treats decisions, plans, backlogs, and evaluations as different document types.

In plain words
What is it for?
Use it when creating, editing, archiving, or organizing documentation, plans, architecture decisions, evaluations, or backlog items in beacon-docs.
Why use it?
It prevents duplicate, misplaced, or ambiguously named documents and keeps important project decisions available after a conversation ends.

Instructions file for CodexOpenCode

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

This is Juliocbm/beacon-docs's own configuration. It tells Codex and OpenCode how to work on beacon-docs 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 beacon-docs configures →

Reuse

Borrowing it

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

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 beacon-docs AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/juliocbm/beacon-docs/agents-md/github.svg)](https://agentmods.dev/instructions/juliocbm/beacon-docs/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/juliocbm/beacon-docs/agents-md"><img src="https://agentmods.dev/badge/instructions/juliocbm/beacon-docs/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.

agentmods 80×15 button for beacon-docs AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/juliocbm/beacon-docs/agents-md"><img src="https://agentmods.dev/badge/instructions/juliocbm/beacon-docs/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,189 This file is loaded in full into every session.
When invoked 1,189 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.01189 $0.01189
Opus 5.5 $0.00476 $0.00476
Sonnet 5.5 $0.00238 $0.00238
Haiku 4.5 $0.00119 $0.00119

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

Security

Grade A, and why

beacon-docs 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 1mo 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.

Origin

Copies of this mod

2 near-identical copies found in the catalogue:

AGENTS.md · 62 lines

How it starts

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

AGENTS.md — Documentation Convention

Read by OpenAI Codex / GitHub Copilot. Full convention: docs/_meta/convention.md.

Universal rules

  1. One doc = one category. Never duplicate across folders.
  2. Status via folder, never filename. Closed plan → _archive/, never *_DONE.md or *_v2.md.
  3. kebab-case for all filenames. No camelCase, no snake_case, no spaces.
  4. README required in every category folder.
  5. ADRs are append-only. Supersede with a new ADR; never edit an accepted one.
  6. Evaluations are immutable snapshots. To revise, create a new dated file.
  7. Plans archive to _archive/ when done. Move them, never rename.
  8. Generated AI files (this one) must match docs/_meta/convention.md. Run beacon sync after editing the convention.
  9. Don't create folders outside the convention. Run beacon enable <addon> or propose an ADR.

Persistence rule: Decisions live in ADRs, multi-step work lives in plans, deferred work lives in backlog, retrospection lives in evals. Chat memory is session-scoped and lost when the conversation ends. If you find yourself relying on chat memory to track a decision, plan, or follow-up — write the document instead.

Project-specific rules

  • operations/*.guide.md — deploy guides, admin runbooks, troubleshooting. Post-mortems go in evaluations/.

Where does X go?

Question Folder
"How is X done technically?" reference/
"How is the system structured?" architecture/
"Why was X decided?" adr/
"What is being built right now?" plans/
"What is on the future backlog?" backlog/
"What was the state at date X?" evaluations/
"How do I deploy/administer X?" operations/

Workflow triggers — when to create documents

These are the conversational signals that should prompt you to create or update Beacon documents. Treat them as imperatives, not suggestions.

Read the full file on GitHub · 62 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. 1mo ago First seen · 62 lines · 1,189 tokens per session scan A aa9ae8ebd462

Subscribe to this mod's changes

beacon-docs AGENTS.md is an instructions file published in the GitHub repository Juliocbm/beacon-docs (6 stars, last pushed 4mo ago), licensed MIT. It adds 1,189 tokens to every session, about $0.0048 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.

Related

Other instructions, from other repositories

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 · 9,649 tokens

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,257 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, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 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,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,731 tokens

deepseek-harness AGENTS.md

AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.

deepseek-ai/deepseek-harness · 4,159 tokens