shopmon AGENTS.md

shopmon AGENTS.md is an instructions file for Codex, OpenCode from FriendsOfShopware/shopmon. It costs 1,961 tokens per session, scanned A, original, MIT.

A project-specific AGENTS.md instruction file for the Shopmon application. It documents the project's architecture, technologies, directory layout, coding conventions, and error-handling guidance.

In plain words
What is it for?
Use it as a guide when modifying Shopmon's Go API, Vue and TypeScript frontend, PostgreSQL database, queues, storage, or observability code.
Why use it?
It gives coding agents and contributors the local rules they need instead of making them infer the structure and conventions from the repository. This helps keep changes aligned with the existing project.

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

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

README.md
[![agentmods](https://agentmods.dev/badge/instructions/friendsofshopware/shopmon/agents-md.svg)](https://agentmods.dev/instructions/friendsofshopware/shopmon/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/friendsofshopware/shopmon/agents-md"><img src="https://agentmods.dev/badge/instructions/friendsofshopware/shopmon/agents-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 1,961 This file is loaded in full into every session.
When invoked 1,961 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.01961 $0.01961
Opus 5 $0.00981 $0.00981
Sonnet 5 $0.00392 $0.00392
Haiku 4.5 $0.00196 $0.00196

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

Security

Grade A, and why

shopmon 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 today.

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 · 187 lines

How it starts

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

Project Architecture & Development Guidelines

Tech Stack

  • API: Go (chi router, Huma v2, sqlc, go-queue)
  • Frontend: Vue.js + TypeScript
  • Database: PostgreSQL (pgx)
  • Queue: PostgreSQL (go-queue), optionally AMQP (LavinMQ/RabbitMQ) via QUEUE_TRANSPORT=amqp
  • Storage: S3-compatible (deployment outputs)
  • Observability: OpenTelemetry (traces + logs via OTLP)

Directory Structure

api/                          <-- Go API (single binary)
  main.go                     <-- Cobra CLI entry point
  server.go                   <-- HTTP server command
  worker.go                   <-- Background worker command
  migrate.go                  <-- Database migration command
  fixtures.go                 <-- Test fixture seeding
  internal/
    api/                      <-- Hand-written HTTP DTO types (API models)
    authapi/                  <-- Hand-written HTTP DTO types (auth models)
    apirouter/                <-- Huma-on-chi mount + OpenAPI metadata
    auth/                     <-- Authentication (credentials, OAuth, SSO, passkeys, orgs, admin)
    config/                   <-- Environment configuration
    crypto/                   <-- AES-GCM encryption
    database/queries/         <-- sqlc-generated data access (DO NOT EDIT)
    handler/                  <-- API endpoint handlers (Huma operations)
    httputil/                 <-- Shared HTTP helpers + Huma JSON error override
    jobs/                     <-- Background job handlers + task types (environment scrape, sitespeed, cleanup)
    mail/                     <-- SMTP service + email templates
    middleware/               <-- HTTP middleware (auth, org membership, environment access)
    shopware/                 <-- Shopware admin API client (per-shop)
      checker/                <-- Environment health check system
    shopwareaccount/          <-- Shopware account/store API client (api.shopware.com)
    storage/                  <-- S3 storage for deployment outputs
    telemetry/                <-- OpenTelemetry tracing + logging setup
    testutil/                 <-- Test infrastructure (testcontainers for Postgres + Redis)
    webui/                    <-- Embedded frontend serving
  migrations/                 <-- SQL migration files (golang-migrate)
  sql/
    schema.sql                <-- Full DDL for sqlc
    queries/                  <-- sqlc query definitions
frontend/                     <-- Vue.js frontend

Read the full file on GitHub · 187 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. today First seen · 187 lines · 1,961 tokens per session scan A fbe20f7d54d9

Subscribe to this mod's changes

shopmon AGENTS.md is an instructions file published in the GitHub repository FriendsOfShopware/shopmon (71 stars, last pushed yesterday), licensed MIT. It adds 1,961 tokens to every session, about $0.0098 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-09-04.

Related

Other instructions, from other repositories

next.js AGENTS.md

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

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

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

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,469 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