What is awesome-petdash AGENTS.md?

A set of project instructions stored in AGENTS.md for the awesome-petdash repository. It describes the repository map, plugin architecture, catalog rules, and development documentation to read.

Use it to guide work on the catalog, plugins, plugin documentation, runtime behavior, and Control Center interface.

It gives coding agents the project context and rules they need before changing repository or plugin code.

How andyluu98/awesome-petdash configures Codex and OpenCode

Reuse

Borrowing it

Nothing to install: this file belongs to andyluu98/awesome-petdash. 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/andyluu98/awesome-petdash/main/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/andyluu98/awesome-petdash

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.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/andyluu98/awesome-petdash/agents-md/github.svg)](https://agentmods.dev/instructions/andyluu98/awesome-petdash/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/andyluu98/awesome-petdash/agents-md"><img src="https://agentmods.dev/badge/instructions/andyluu98/awesome-petdash/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.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/andyluu98/awesome-petdash/agents-md"><img src="https://agentmods.dev/badge/instructions/andyluu98/awesome-petdash/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 803 This file is loaded in full into every session.

When invoked 803 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.

Model	Per session	Once invoked
Fable 5.1	$0.00803	$0.00803
Opus 5.5	$0.00321	$0.00321
Sonnet 5.5	$0.00161	$0.00161
Haiku 4.5	$0.00080	$0.00080

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

Security

Grade A, and why

awesome-petdash 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 · 57 lines

How it starts

The opening of the file, as written. The whole thing — 57 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.

Catalog Direction

Catalog v2 is legacy and exists only for old app versions/fallback compatibility. For new work, migrations, and Control Center UI, do not optimize for v2 behavior. Use catalog v3 (thumbnail, spritesheet, paginated pages, and search index) as the source of truth.

Plugin Docs

Before changing plugin platform code, official plugins, plugin catalog generation, plugin packaging, plugin runtime behavior, or plugin-facing UI, read:

docs/plugins.md for the current plugin platform architecture, manifest/runtime rules, local development workflow, publishing commands, and troubleshooting notes.
docs/new_plugins.md for the companion-first Windows plugin direction, planned official plugin lineup, bundling defaults, and right-click plugin action strategy.

When plugin work is finished, update these docs if behavior, commands, manifests, plugin IDs, default bundled/enabled status, catalog workflow, permissions, or the planned plugin lineup changed. Do not leave plugin docs stale after implementation.

Logging for Fast DX

When working on desktop UI, renderer, IPC, catalog, plugin, or pet-window behavior, add targeted logging as part of the implementation when it helps diagnose issues quickly. Prefer concise, scoped logs that capture data shape, selected IDs, load/error states, and boundary decisions. Route renderer diagnostics into the app log when possible so failures are visible in openpets.log, not only DevTools. Avoid noisy permanent logs, secrets, full payload dumps, or logging in tight animation/render loops.

Control Center CSP

When adding any renderer-visible URL scheme, image source, dev server endpoint, or internal protocol, update the Control Center CSP in both apps/desktop/vite.config.ts and apps/desktop/src/renderer/index.html. Common pet image protocols include openpets-codex:, openpets-installed:, and openpets-pet-preview:; forgetting CSP causes images to load as the default/fallback pet even when install/render logic is correct.

Read the full file on GitHub · 57 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.

2mo ago First seen · 57 lines · 803 tokens per session scan A 1f71e4891787

Subscribe to this mod's changes

awesome-petdash AGENTS.md is an instructions file published in the GitHub repository andyluu98/awesome-petdash (1 stars, last pushed 5mo ago), licensed MIT. It adds 803 tokens to every session, about $0.0032 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-31.

awesome-petdash AGENTS.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
awesome-petdash AGENTS.mdandyluu98/awesome-petdash	Instructions file	1	5mo ago	MIT	A	803	Codex, OpenCode
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	today	MIT	A	7,461	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	5,649	GitHub Copilot
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	today	MIT	A	4,680	Codex, OpenCode
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	3,093	GitHub Copilot
vscode model-prompts.instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	2,022	GitHub Copilot

awesome-petdash: Instructions file for Codex