monofield / packages
AGENTS.md5 starsChanged 5 months agoApache-2.0View on GitHub
Follow the root AGENTS.md first. This file only records module-level boundaries for packages/.
We split this AGENTS.md into the rules it gives an agent
5 rules. About 0 are common, 1 is distinctive, and 4 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
4
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 3
Follow the root AGENTS.md first.
- Very specific: line 24
Do not move runtime validation/schema enforcement into contracts prematurely.
- Distinctive: line 25
Do not let app packages depend directly on sidecar control-plane details.
- Very specific: line 26
Do not hard-code Open Design app/source/mode constants in sidecar or platform.
- Very specific: line 27
Keep stamp fields limited to five: app, mode, namespace, ipc, and source.
≈ “Common” is an estimate: at least 1 in 5 of the 36,368 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
packages/AGENTS.md
Follow the root AGENTS.md first. This file only records module-level boundaries for packages/.
Package responsibilities
packages/contracts: web/daemon app contract layer. Keep it pure TypeScript; it must not depend on Next.js, Express, Node filesystem/process APIs, browser APIs, SQLite, daemon internals, or the sidecar control-plane protocol.packages/components: shared React UI primitives and primitive CSS. It may depend on React types/runtime only; keep product workflows and app-specific layout/styling in the apps.packages/host: web/desktop host bridge contract. It models renderer-facing host capabilities and helpers while keepingwindow.__od__access out of app UI code.packages/metatool: internal metadata helpers for repo-local tool build outputs. Keep reusable hash/check/write mechanics here; each concrete tool owns its ownmeta.json.packages/release: pure release-domain primitives. Owns release channel names, version parsing/formatting, metadata field derivation, storage prefixes, release namespaces, and app identity data. It must not read/write files, call GitHub/R2, spawn build tools, or own workflow execution.packages/sidecar-proto: Open Design sidecar business protocol. Owns app/mode/source constants, namespace validation, stamp descriptor/fields/flags, IPC message schema, status shapes, error semantics, and default product path constants.packages/sidecar: generic sidecar runtime primitives. Includes bootstrap, IPC transport, path/runtime resolution, launch env, and JSON runtime file helpers; it must not hard-code Open Design app keys or IPC business messages.packages/platform: generic OS process primitives. Includes stamp serialization, command parsing, process matching/search, and well-known user-toolchain bin discovery; it must consume thesidecar-protodescriptor and must not hard-code--od-stamp-*details. The toolchain helper is the single source of truth shared by the daemon agent resolver (apps/daemon/src/agents.ts) and the packaged sidecar PATH builder (apps/packaged/src/sidecars.ts) so neither layer can drift the search list.
Removed directories
packages/sharedhas been removed; do not restore it.- For new shared types, choose the boundary first: web/daemon app DTOs go in
contracts; sidecar control-plane protocol goes insidecar-proto; generic runtime code goes insidecar; generic OS/process code goes inplatform.
Boundary checklist
- Package tests live in each package's
tests/directory, sibling tosrc/; keepsrc/source-only and do not add new*.test.tsor*.test.tsxfiles undersrc/. - Do not move runtime validation/schema enforcement into
contractsprematurely; current contracts define the typed target shape only. - Do not let app packages depend directly on sidecar control-plane details.
- Do not hard-code Open Design app/source/mode constants in
sidecarorplatform. - Keep stamp fields limited to five:
app,mode,namespace,ipc, andsource.
Common package commands
pnpm --filter @open-design/contracts typecheck
pnpm --filter @open-design/host typecheck
pnpm --filter @open-design/host test
pnpm --filter @open-design/metatool typecheck
pnpm --filter @open-design/metatool test
pnpm --filter @open-design/release typecheck
pnpm --filter @open-design/release test
pnpm --filter @open-design/sidecar-proto typecheck
pnpm --filter @open-design/sidecar-proto test
pnpm --filter @open-design/sidecar typecheck
pnpm --filter @open-design/sidecar test
pnpm --filter @open-design/platform typecheck
pnpm --filter @open-design/platform testWhere files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 28,693 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository168 other files it gives its agents.
- AGENTS.mdAGENTS.md
- apps/AGENTS.mdAGENTS.md
- design-templates/AGENTS.mdAGENTS.md
- e2e/AGENTS.mdAGENTS.md
- .github/AGENTS.mdAGENTS.md
- plugins/AGENTS.mdAGENTS.md
- skills/AGENTS.mdAGENTS.md
- tools/AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- od-contributeSkill
- 8-bit-orbit-video-templateSkill
- ad-creativeSkill
- after-hours-editorial-templateSkill
- agent-browserSkill
- ai-music-albumSkill
- algorithmic-artSkill
- apple-higSkill
- article-magazineSkill
- artifacts-builderSkill
- brainstormingSkill
- brand-extractSkill
- brand-guidelinesSkill
- brandkitSkill
- industrial-brutalist-uiSkill
- canvas-designSkill
- card-twitterSkill
- card-xiaohongshuSkill
- color-expertSkill
- competitive-ads-extractorSkill
- copywritingSkill
- creative-directorSkill
- d3-visualizationSkill
- data-reportSkill
- deck-guizang-editorialSkill
- deck-open-slide-canvasSkill
- deck-swiss-internationalSkill
- design-briefSkill
- design-consultationSkill
- design-mdSkill
- design-reviewSkill
- digits-fintech-swiss-templateSkill
- doc-kami-parchmentSkill
- docSkill
- docxSkill
- domain-name-brainstormerSkill
- ecommerce-image-workflowSkill
- editorial-burgundy-principles-templateSkill
- emilkowalski-motionSkill
- enhance-promptSkill
- export-download-debuggingSkill
- fal-3dSkill
- fal-generateSkill
- fal-image-editSkill
- fal-kling-o3Skill
- fal-lip-syncSkill
- fal-realtimeSkill
- fal-restoreSkill
- fal-trainSkill
- fal-tryonSkill
- fal-upscaleSkill
- The first 60 shown.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
Reviews can't be read right now.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

