roamcode AGENTS.md

Repository instructions for RoamCode, including rules for developing, releasing and updating a public software project.

In plain words
What is it for?
Use them when modifying RoamCode, preparing stable releases, changing over-the-air updates or testing installation and startup safely.
Why use it?
They prevent accidental exposure of secrets or private machine details and clarify that publishing code alone does not automatically update users.

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

Made for: Codex, OpenCode.

Per session 1,281 This file is loaded in full into every session.
When invoked 1,281 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.01281 $0.01281
Opus 5 $0.00641 $0.00641
Sonnet 5 $0.00256 $0.00256
Haiku 4.5 $0.00128 $0.00128

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

Security

Grade A, and why

roamcode 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 · 88 lines

How it starts

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

Repository instructions for coding agents

These instructions apply to the entire repository. This is a public repository: write every file, commit, log, issue, release note, and command as if it will be visible to anyone on the internet.

Public-repository safety

  • Never commit, print, paste, or request credentials, access tokens, cookies, private keys, .npmrc contents, signing material, or authenticated URLs. Use the existing GitHub environments and trusted publishing.
  • Never add a maintainer's username, home directory, machine-specific absolute path, private hostname, tunnel URL, session identifier, or production log contents to the repository.
  • Keep local service data, live sessions, and unrelated worktree changes intact. Do not clean, reset, or overwrite changes that are outside the requested task.
  • Do not mutate or restart a developer's installed RoamCode service merely to test a change. A live install, manual migration, rollback, or restart requires an explicit user request. Use isolated tests and GitHub Actions for boot and package-install smoke tests.

Stable release and OTA contract

  • A commit or push to main is not an update. Users discover updates only through stable, non-draft GitHub Releases.
  • Stable SemVer (X.Y.Z) is the only release identity. The workspace, CLI, server, web package, npm artifacts, GitHub tag/release, release manifest, and Homebrew formula must agree on the exact version.
  • The stable release workflow must publish npm artifacts and the Homebrew formula before it creates the discoverable GitHub Release. Never manually reverse this order.
  • OTA installs the exact npm version whose integrity is recorded in roamcode-release.json; do not reintroduce commit-, branch-, or checkout-based update behavior.
  • Release descriptions are user-facing OTA data. scripts/release-notes.mjs extracts them from CHANGELOG.md, and the web client groups their Markdown bullets under headings such as Added, Fixed, and Changed. Every release section must contain at least one accurate bullet so What's new is never empty.
  • Never reuse a published version for different package bytes. If a workflow fails, first determine which external artifacts exist; resume only when the workflow can prove any existing immutable npm artifacts match exactly.

Read the full file on GitHub · 88 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 · 88 lines · 1,281 tokens per session scan A c3bacc8400ee

Subscribe to this mod's changes

roamcode AGENTS.md is an instructions file published in the GitHub repository burakgon/roamcode (19 stars, last pushed 3d ago), licensed MIT. It adds 1,281 tokens to every session, about $0.0064 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.