roam-code: Instructions file for Codex

AGENTS.md

roam-code AGENTS.md is an instructions file for Codex, OpenCode from Cranot/roam-code. It costs 14,965 tokens per session, scanned A, original, Apache-2.0.

A project guide for roam-code, a local command-line tool that maps code symbols, call relationships, dependencies, architecture, and Git history into a local database.

In plain words
What is it for?
Use it when developing roam-code, finding its documentation, or deciding how private and public project files should be handled.
Why use it?
It gives developers and coding agents a shared reference for what the project does, where files belong, and how to maintain its quality.

Instructions file for CodexOpenCode

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

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

Reuse

Borrowing it

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

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 roam-code AGENTS.md

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/cranot/roam-code/agents-md"><img src="https://agentmods.dev/badge/instructions/cranot/roam-code/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 14,965 This file is loaded in full into every session.
When invoked 14,965 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.14965 $0.14965
Opus 5.5 $0.05986 $0.05986
Sonnet 5.5 $0.02993 $0.02993
Haiku 4.5 $0.01496 $0.01496

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

Security

Grade A, and why

roam-code 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 6d 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 · 875 lines

How it starts

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

AGENTS.md — roam-code development guide

What this project is

roam-code is a local codebase intelligence CLI for developers and AI coding agents. It pre-indexes symbols, call graphs, dependencies, architecture, and git history into a local SQLite DB. 288 commands · 259 MCP tools (17 in the default core preset) · 28 languages · local analysis · zero API keys.

Authoritative counts (AST-derived, env-independent): command_count: 288 · canonical_count: 281 · category_count: 7 · mcp tools registered: 259 · mcp tools in core preset: 17. The roam surface --json envelope additionally exposes mcp_tool_count_by_preset for per-preset counts.

Package: roam-code on PyPI. Entry point: roam.cli:cli.

Documentation Hub

  • Orientation (read once before anything else): docs/understanding-roam.md — what roam is, why it is mechanical and agent-first, what has been measured, how we speak, and how to gate on its output.
  • Dogfood corpus (read for quality lessons): internal/dogfood/ — 212-eval corpus + 6 systemic-pattern synthesis. Single most important reference for understanding what good roam-command behavior looks like. Start with internal/dogfood/README.md. (Private — gitignored; not shipped to PyPI/GitHub.)
  • Getting started tutorial: templates/distribution/landing-page/docs/getting-started.html
  • Command reference with examples: templates/distribution/landing-page/docs/command-reference.html
  • Architecture guide and diagram: templates/distribution/landing-page/docs/architecture.html
  • Detector evidence and limitations: docs/concepts/detector-evidence.md — static graph coverage, language context, confidence semantics, and command-scope differences.
  • Live URL: https://roam-code.com/docs/

Where files go (private vs public)

Read the full file on GitHub · 875 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. 6d ago Changed dcf32beb63a5
  2. 14d ago Changed d0cf960cb763
  3. 1mo ago Changed · +2 lines · +17 tokens per session 3933c188d437
  4. 1mo ago Changed · +1 lines · +58 tokens per session 46adea68f8b2
  5. 1mo ago Changed · +20 lines · +274 tokens per session 7b47175aba69
  6. 1mo ago Changed · +18 lines · +374 tokens per session cab1e670f40d
  7. 1mo ago First seen · 834 lines · 14,242 tokens per session scan A 383e4153dc7c

Subscribe to this mod's changes

roam-code AGENTS.md is an instructions file published in the GitHub repository Cranot/roam-code (517 stars, last pushed 2d ago), licensed Apache-2.0. It adds 14,965 tokens to every session, about $0.0599 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-30.

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

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

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