Home / canonry / canonry · GitHub

AGENTS.md@packages/canonryB

AGENTS.md@packages/canonry from canonry/canonry is an AGENTS.md file: the standing instructions coding agents read in that repo.

Install it, pinned
mdr add canonry/canonry/packages/canonry/AGENTS.md@git:20261017.9f06b9b

Pins git:20261017.9f06b9b in mdr.lock. Pin the fingerprint instead.

Audit grade
B, 13 of 14 checks passed
Kind
AGENTS.md file
Repository
canonry/canonry
Path
packages/canonry/AGENTS.md
Versions recorded
62
Latest version
git:20261017.9f06b9b, committed Oct 17, 2026
First version recorded
Aug 17, 2026
Size
129,418 bytes
Repository stars
187
License
MIT

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

# canonry

## Purpose

The publishable npm package (`@canonry/canonry`). Bundles the CLI, local Fastify server, in-process job runner, provider registry, scheduler, and pre-built SPA. This is what users install with `npm install -g @canonry/canonry`.

## Key Files

| File | Role |
|------|------|
| `src/cli.ts` | CLI entry point — shebang, telemetry, command dispatch |
| `src/cli-commands.ts` | `REGISTERED_CLI_COMMANDS` array — declarative command specs (see "How to add a CLI command") |
| `src/commands/` | Command implementations (one file per domain); their CLI specs live in `src/cli-commands/` |
| `src/client.ts` | `ApiClient` class + `createApiClient()` factory (see "ApiClient usage") |
| `src/server.ts` | Fastify server setup — mounts api-routes, serves SPA, registers providers (see "Server and SPA serving") |
| `src/embed.ts` | `resolveEmbedConfig(env, config)` — resolves embed mode (see "Embed mode (#716)") |
| `src/agent-config.ts` | `resolveAgentEnabled(env, config)` — the Aero kill-switch (rules: `src/agent/AGENTS.md`) |
| `src/job-runner.ts` | In-process job runner for visibility sweeps (see "Run completion pipeline") |
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add canonry/canonry/packages/canonry/AGENTS.md@sha256:5fbd154fd89441cf

The line at the top of this page pins the label git:20261017.9f06b9b, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_2r4fvvtuhekupsn2.svg)](https://markdownregistry.com/a/art_2r4fvvtuhekupsn2)

6 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 62 versions of this file, between Aug 17, 2026 and Oct 17, 2026, about one every day.

versioncommittedcommitsizeaudit
git:20261017.9f06b9b latest2026-10-17 9f06b9b 129,418 BB view · diff
git:20261015.9ce35e02026-10-15 9ce35e0 129,150 BB view · diff
git:20261015.c8ecbd82026-10-15 c8ecbd8 128,802 BB view · diff
git:20261014.c90d2262026-10-14 c90d226 128,840 BB view · diff
git:20261013.1c908112026-10-13 1c90811 128,717 BB view · diff
git:20261012.89a7b4b2026-10-12 89a7b4b 127,896 BB view · diff
git:20261012.e8bc9e52026-10-12 e8bc9e5 126,768 BB view · diff
git:20261011.041436a2026-10-11 041436a 121,517 BB view · diff
git:20261011.7e9e4a62026-10-11 7e9e4a6 120,562 BB view · diff
git:20261010.057e3342026-10-10 057e334 120,227 BB view · diff
git:20261010.8c7755d2026-10-10 8c7755d 116,976 BB view · diff
git:20261010.f2214812026-10-10 f221481 116,069 BB view · diff
git:20261009.e760bb22026-10-09 e760bb2 112,642 BB view · diff
git:20261009.32caa112026-10-09 32caa11 112,369 BB view · diff
git:20261008.8eb97202026-10-08 8eb9720 108,970 BA view · diff
git:20261008.0c7138f2026-10-08 0c7138f 108,088 BA view · diff
git:20261008.df2022e2026-10-08 df2022e 107,424 BA view · diff
git:20261008.1ef30fa2026-10-08 1ef30fa 102,144 BA view · diff
git:20261008.6f387d82026-10-08 6f387d8 101,748 BA view · diff
git:20261005.3fbd4022026-10-05 3fbd402 94,681 BA view · diff
git:20261005.d6cdf2c2026-10-05 d6cdf2c 96,650 BA view · diff
git:20261005.e9d50b42026-10-05 e9d50b4 95,717 BA view · diff
git:20261005.00662672026-10-05 0066267 92,594 BA view · diff
git:20261005.6a2c5dd2026-10-05 6a2c5dd 93,361 BA view · diff
git:20261002.3a398952026-10-02 3a39895 89,494 BA view · diff
git:20260929.728d0072026-09-29 728d007 89,434 BA view · diff
git:20260928.b528a182026-09-28 b528a18 89,355 BA view · diff
git:20260928.927559d2026-09-28 927559d 89,331 BA view · diff
git:20260928.54ba11c2026-09-28 54ba11c 85,711 BA view · diff
git:20260928.a39f6872026-09-28 a39f687 84,615 BA view · diff
git:20260928.6369ada2026-09-28 6369ada 82,637 BA view · diff
git:20260925.ce286872026-09-25 ce28687 72,216 BA view · diff
git:20260923.f41fd9c2026-09-23 f41fd9c 72,219 BA view · diff
git:20260923.fbd3ec62026-09-23 fbd3ec6 71,781 BA view · diff
git:20260922.f55491f2026-09-22 f55491f 71,462 BA view · diff
git:20260919.46b60a62026-09-19 46b60a6 71,081 BA view · diff
git:20260914.40be8572026-09-14 40be857 83,594 BA view · diff
git:20260913.56f0f162026-09-13 56f0f16 83,153 BA view · diff
git:20260913.1f106582026-09-13 1f10658 82,413 BA view · diff
git:20260912.267b6412026-09-12 267b641 80,494 BA view · diff
git:20260912.2c66fea2026-09-12 2c66fea 77,558 BA view · diff
git:20260912.c12e4962026-09-12 c12e496 77,357 BA view · diff
git:20260912.92ebeea2026-09-12 92ebeea 75,805 BA view · diff
git:20260912.9cc37ab2026-09-12 9cc37ab 75,729 BA view · diff
git:20260910.f210e302026-09-10 f210e30 74,928 BA view · diff
git:20260910.2bcbc862026-09-10 2bcbc86 74,739 BA view · diff
git:20260909.6c666ac2026-09-09 6c666ac 72,750 BA view · diff
git:20260909.672d4df2026-09-09 672d4df 72,444 BA view · diff
git:20260908.28875cc2026-09-08 28875cc 72,058 BA view · diff
git:20260908.d4c10fe2026-09-08 d4c10fe 71,770 BA view

Audit of the latest version

B  13 of 14 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • fail: No link to a raw IP address (matched: http://127.0.0.1:4100)
  • pass: Size between 200 bytes and 200 KB (129418 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No script tag

Starting a new one? Use a template for AGENTS.md on mdpantry, which passes every one of these checks and says what to change in it.

Source

GitHub

canonry/canonry · 187 stars · license MIT · pushed 2026-10-19 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_2r4fvvtuhekupsn2
GET https://markdownregistry.com/api/v1/resolve?ref=canonry/canonry/packages/canonry/AGENTS.md
GET https://markdownregistry.com/api/v1/blob/5fbd154fd89441cfc805770cb5f761dd39c8e83211438fd55bbeaecad7f059d2

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: how to write a good AGENTS.md · AGENTS.md vs CLAUDE.md · which agent file does what.

More from canonry/canonry

test-audit SKILL.md skill
canonry/canonry · .agents/skills/test-audit/SKILL.md · Invoke whenever writing, changing, reviewing, running, or sweeping Canonry tests. Authoring gate for new tests plus…
git:20261015.3a14a05 · audit A · 187 stars
AGENTS.md AGENTS.md file
canonry/canonry · AGENTS.md
git:20261015.c8ecbd8 · audit A · 187 stars
DESIGN.md DESIGN.md file
canonry/canonry · DESIGN.md
git:20261010.862ea14 · audit A · 187 stars
AGENTS.md@apps/api AGENTS.md file
canonry/canonry · apps/api/AGENTS.md
git:20261007.254a7fb · audit A · 187 stars
AGENTS.md@apps/vals/ai-visibility-check AGENTS.md file
canonry/canonry · apps/vals/ai-visibility-check/AGENTS.md
git:20260912.c12e496 · audit A · 187 stars
AGENTS.md@apps/vals/brand-perception-check AGENTS.md file
canonry/canonry · apps/vals/brand-perception-check/AGENTS.md
git:20260912.c12e496 · audit A · 187 stars
AGENTS.md@apps/web AGENTS.md file
canonry/canonry · apps/web/AGENTS.md
git:20261015.9ce35e0 · audit A · 187 stars
AGENTS.md@apps/worker AGENTS.md file
canonry/canonry · apps/worker/AGENTS.md
git:20261015.c8ecbd8 · audit A · 187 stars
AGENTS.md@packages/api-client-generated AGENTS.md file
canonry/canonry · packages/api-client-generated/AGENTS.md
git:20261015.c8ecbd8 · audit A · 187 stars
AGENTS.md@packages/api-routes AGENTS.md file
canonry/canonry · packages/api-routes/AGENTS.md
git:20261015.9ce35e0 · audit A · 187 stars
AGENTS.md@packages/api-routes/src/discovery AGENTS.md file
canonry/canonry · packages/api-routes/src/discovery/AGENTS.md
git:20261007.254a7fb · audit A · 187 stars
AGENTS.md@packages/api-routes/src/doctor AGENTS.md file
canonry/canonry · packages/api-routes/src/doctor/AGENTS.md
git:20261015.c8ecbd8 · audit A · 187 stars

Every file in canonry/canonry

Browse by kind, by grade B, or by owner.