codex-pet-share: Instructions file for Codex

AGENTS.md

codex-pet-share AGENTS.md is an instructions file for Codex, OpenCode from portons/codex-pet-share. It costs 1,027 tokens per session, scanned A, original, MIT.

A contributor guide for Codex Pet Share, a browser app for sharing pet statistics. It explains which files to read first, how the app is structured and how its public settings must stay independent of any one service provider.

In plain words
What is it for?
Use it when setting up the project or changing authentication, APIs, storage, live updates, sharing pages, deployment or the Cloudflare adapter.
Why use it?
It reduces guesswork for new coding sessions and helps prevent breaking the app's provider-neutral interface or changing the wrong adapter.

Instructions file for CodexOpenCode

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

This is portons/codex-pet-share's own configuration. It tells Codex and OpenCode how to work on codex-pet-share 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 codex-pet-share configures →

Reuse

Borrowing it

Nothing to install: this file belongs to portons/codex-pet-share. 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/portons/codex-pet-share/master/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/portons/codex-pet-share

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 codex-pet-share AGENTS.md

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/portons/codex-pet-share/agents-md"><img src="https://agentmods.dev/badge/instructions/portons/codex-pet-share/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,027 This file is loaded in full into every session.
When invoked 1,027 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.01027 $0.01027
Opus 5.5 $0.00411 $0.00411
Sonnet 5.5 $0.00205 $0.00205
Haiku 4.5 $0.00103 $0.00103

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

Security

Grade A, and why

codex-pet-share 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 2mo 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 · 123 lines

How it starts

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

Agent Guide

This repo is intended to be workable by a fresh Codex/Claude session with no private context. Keep changes small, provider-neutral at the public boundary, and easy to verify from a clean checkout.

First Read

  1. Read README.md.
  2. Read docs/GETTING_STARTED.md for zero-to-working setup.
  3. Read docs/PROVIDER_ADAPTERS.md before changing auth, API, storage, realtime, social share pages, or deployment.
  4. Read adapters/cloudflare-worker/README.md before changing the checked-in Cloudflare adapter.

Public Provider Contract

The browser app should not depend on provider-named public env vars.

Required public build vars:

  • VITE_APP_API_BASE_URL
  • VITE_PUBLIC_APP_ORIGIN
  • VITE_REALTIME_URL
  • VITE_REALTIME_PUBLIC_KEY
  • VITE_APP_NAME
  • VITE_APP_HANDLE
  • VITE_APP_TAGLINE
  • VITE_APP_REPO_URL

Current adapter-specific vars live outside that public contract:

  • PET_STATS_SALT
  • APP_NAME
  • APP_HANDLE
  • APP_TAGLINE
  • APP_API_BASE_URL
  • ASSET_PUBLIC_BASE_URL
  • CORS_ALLOWED_ORIGINS

Do not add provider-specific public names unless the user explicitly asks.

Architecture Map

  • src/domain/*: shared types, routing, API URLs, formatting, pet helpers, session storage, and frontend constants.
  • src/realtime/providerClient.ts, src/realtime/roomChannel.ts: generic realtime surfaces used by the app.
  • src/realtime/adapters/*: provider-specific realtime adapters and current adapter barrels.
  • src/app/App.tsx: SPA composition.
  • src/app/useAppEntityData.ts, src/app/useAppRouteEffects.ts, src/app/useAppNavigationActions.ts: route data, route effects, and navigation commands.
  • src/app/AppChrome.tsx, src/app/AppDialogs.tsx: app shell chrome and modal composition.
  • src/app/styles.css: CSS import manifest; feature CSS lives beside each feature folder.
  • src/admin/AdminPage.tsx: admin workflows.
  • src/downloads/DownloadCommandRow.tsx: terminal install command UI.
  • src/branding/brand.ts: build-time brand strings.
  • src/playground/PetPlaygroundModal.tsx: 3D playground composition.
  • src/playground/PlaygroundRouteLayers.tsx: playground modal/room route layer.
  • src/playground/animation/*: spritesheet atlas animation state machine, frame/UV application, sprint streaks, dust, and after-image sprite effects.
  • src/playground/core/*: playground constants, scene setup, image loading, projection, and controls hint text.
  • src/playground/hooks/*: playground-specific React hooks.
  • src/playground/room/*: room gate, realtime room UI, remote actors, overlay, and room mode types.
  • src/playground/ui/*: modal header, chat bar, pet picker, NPC picker, touch controls, and popover UI.
  • src/playground/world/*: ball, trampoline, and NPC simulation systems.
  • adapters/cloudflare-worker/src/*: current backend adapter.
  • adapters/cloudflare-worker/migrations/*: current schema adapter.
  • adapters/cloudflare-worker/wrangler.toml: current Cloudflare resource bindings and optional route template.
  • adapters/cloudflare-pages/functions/*: static-host share-page adapter for crawlers.
  • scripts/*: operator scripts.

Read the full file on GitHub · 123 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. 2mo ago First seen · 123 lines · 1,027 tokens per session scan A 4c847178e0e4

Subscribe to this mod's changes

codex-pet-share AGENTS.md is an instructions file published in the GitHub repository portons/codex-pet-share (142 stars, last pushed 1mo ago), licensed MIT. It adds 1,027 tokens to every session, about $0.0041 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

codex-pet-share AGENTS.md compared with instructions from other repositories

codex-pet-share AGENTS.md next to 6 instructions from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
codex-pet-share AGENTS.mdportons/codex-pet-shareInstructions file1421mo agoMITA1,027Codex, OpenCode
vscode buildNext.instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA9,719GitHub Copilot
vscode oss-third-party-notices.instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA5,516GitHub Copilot
next.js AGENTS.mdvercel/next.jsInstructions file143ktodayMITA7,461Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchainInstructions file149ktodayMITA4,680Codex, OpenCode
vscode copilot-instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA3,093GitHub Copilot
vscode model-prompts.instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA2,022GitHub Copilot