codex-pet-share AGENTS.md

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

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/portons/codex-pet-share/agents-md
Clone the repo
git clone --depth 1 https://github.com/portons/codex-pet-share

Made for: Codex, OpenCode.

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. 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.01027 $0.01027
Opus 5 $0.00513 $0.00513
Sonnet 5 $0.00205 $0.00205
Haiku 4.5 $0.00103 $0.00103

Measured 3d ago against content hash 4c847178e0e4, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, 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 3d 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. 3d 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 (125 stars, last pushed 1mo ago), licensed MIT. It adds 1,027 tokens to every session, about $0.0051 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.

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 · 6,785 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 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,345 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, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

next.js 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,296 tokens