openpets AGENTS.md

openpets AGENTS.md is an instructions file for Codex, OpenCode from alvinunreal/openpets. It costs 2,089 tokens per session, scanned A, original, MIT.

Repository instructions for the alvinunreal/openpets project. They explain where to find the project map, documentation, architecture details, and rules for protecting behaviour with tests.

In plain words
What is it for?
Use them when working on OpenPets code, documentation, desktop features, local communication, pet behaviour, or related tests.
Why use it?
They give an agent the project context and working rules it needs before changing code, reducing the risk of misplaced or incompatible edits.

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

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 openpets AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/alvinunreal/openpets/agents-md.svg)](https://agentmods.dev/instructions/alvinunreal/openpets/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/alvinunreal/openpets/agents-md"><img src="https://agentmods.dev/badge/instructions/alvinunreal/openpets/agents-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 2,089 This file is loaded in full into every session.
When invoked 2,089 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.02089 $0.02089
Opus 5 $0.01045 $0.01045
Sonnet 5 $0.00418 $0.00418
Haiku 4.5 $0.00209 $0.00209

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

Security

Grade A, and why

openpets 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 4d 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 · 148 lines

How it starts

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

Repository Map

A full codemap is available at codemap.md in the project root.

Before working on any task, read codemap.md to understand:

  • Project architecture and entry points
  • Directory responsibilities and design patterns
  • Data flow and integration points between modules

For deep work on a specific folder, also read that folder's codemap.md.

Documentation Map

docs/ holds the maintained, conceptual documentation — the narrative layer on top of the codemaps. It explains concepts and contracts and points at the files that own each behavior (it deliberately avoids pasting code, which rots). Start at docs/README.md, then read the doc for the area you're touching:

  • docs/architecture.md — system overview, runtime topology, package spine, end-to-end flows, cross-cutting invariants, glossary. Read first.
  • docs/desktop.md — the Electron app: process model, tray/Control Center, windows, app state, lifecycle, security, logging, CSP.
  • docs/ipc.md — local IPC protocol + @open-pets/client: discovery, transports, the lease model, request surface, security.
  • docs/pets.md — pet model, reactions→animations→speech, installation, Codex pets, motion.
  • docs/catalog.md — pet/plugin catalog contracts (v3/v2), pagination, search, R2 ZIP hosting, and how the app consumes them.
  • docs/agent-integrations.md — Claude/MCP/OpenCode/Cursor/Pi + the CLI.
  • docs/plugins.md — plugin platform: manifest, permissions, runtime, sandbox, install paths, packaging/publishing, troubleshooting.
  • docs/official-plugins.md — companion-first direction, official lineup, bundling/enabled defaults, right-click action strategy.
  • docs/sdk.md — public SDK v3 contract + the deterministic test harness.
  • docs/i18n.md — translations across host UI, reaction speech, and plugins.
  • docs/development.md — DX: layout, command surface, dev modes, releases.
  • docs/testing-and-validation.md — tests, contracts, release validators, catalog verification, and what "production-valid" means before shipping.

Read the full file on GitHub · 148 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. 4d ago First seen · 148 lines · 2,089 tokens per session scan A 8e24daa7eacf

Subscribe to this mod's changes

openpets AGENTS.md is an instructions file published in the GitHub repository alvinunreal/openpets (1,149 stars, last pushed 5d ago), licensed MIT. It adds 2,089 tokens to every session, about $0.0104 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.