Portable_Web_toolkit
AGENTS.md2 starsChanged 4 months agoMITView on GitHub
Blind agents: read START_HERE.md first — zero research required. Repo-local rules for AI agents using the Portable Astro + Cloudflare Web Toolkit (Web_Toolkit/). 1. The active client repository's applicable instructions when operating on a client site 2. START_HERE.md for toolkit orientation 3. The narrow installed skill in skills/ 4. Web_Toolkit/OPERATIONS.md only when detailed operations are relevant 5. Current source, manifests, profiles, tests, and runtime evidence Do not load docs/templates/AGENT.template.md for toolkit work — that template is for other projects. All…
- Reads credentials
Where 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 31,700 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 repository15 other files it gives its agents.
- Web_Toolkit/AGENTS.mdAGENTS.md
- brand-doctorSkill
- discovery-doctorSkill
- image-pipelineSkill
- instagram-cloneSkill
- pagespeed-diagnosticsSkill
- portable-web-toolkit-routerSkill
- portable-web-toolkitSkill
- site-maintenanceSkill
- site-onboardingSkill
- site-readinessSkill
- site-starterSkill
- toolkit-updateSkill
- vectorize-pipelineSkill
- wcag-auditorSkill
The file
We split this AGENTS.md into the rules it gives an agent
10 rules. About 0 are common, 5 are distinctive, and 5 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈5
Distinctive · estimate
This author's own choices. Worth a look.
5
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 20
All operator modules live under:
- Distinctive: line 30
Follow the host's actual system, administrator, user, repository, and nested instruction precedence.
- Distinctive: line 33
When operating on a client site:
- Distinctive: line 54
Spec-driven: read the site profile before deploy, DNS, or branding changes.
- Very specific: line 56
Runtime artifacts: keep generated output in Web_Toolkit/.runtime/, not in publishable source.
- Very specific: line 57
Discovery layer: use the established toolkit generators and discovery-doctor when the client repository adopts that contract.
- Very specific: line 65
Assets: no stock/placeholder favicons or heroes.
- Distinctive: line 66
Workers-over-external: prefer Cloudflare Workers/bindings (KV, D1, R2, Vectorize) before adding SaaS.
- Very specific: line 67
Version truth: verify Astro/Wrangler/Node from repo + registry — never trust stale model memory.
- Very specific: line 88
Before sharing toolkit: toolkit-purge --apply, privacy-check, toolkit-verify
≈ “Common” is an estimate: at least 1 in 5 of the 40,246 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
Portable Web Toolkit — Agent Instructions
Blind agents: read START_HERE.md first — zero research required.
Repo-local rules for AI agents using the Portable Astro + Cloudflare Web Toolkit (Web_Toolkit/).
Read first (in order)
- The active client repository's applicable instructions when operating on a client site
START_HERE.mdfor toolkit orientation- The narrow installed skill in
skills/ Web_Toolkit/OPERATIONS.mdonly when detailed operations are relevant- Current source, manifests, profiles, tests, and runtime evidence
Do not load docs/templates/AGENT.template.md for toolkit work — that template is for other projects.
Toolkit root
All operator modules live under:
Web_Toolkit/Site-specific behavior comes from site-profiles/*.json (or a private profile path passed with --site-profile). Live secrets belong in the target project root .env, not in the toolkit tree.
Authority and precedence
Follow the host's actual system, administrator, user, repository, and nested instruction precedence.
When operating on a client site:
- client-repository instructions and approved runbooks govern that site
- current source, manifests, tests, and runtime evidence establish state
- Portable Web Toolkit skills supply subordinate domain procedures
- toolkit documentation supplies conditional reference material
This file governs work on the toolkit repository itself. It does not outrank a
client repository merely because Web_Toolkit is linked into that project.
Configuration has scoped authority, not instruction precedence:
- a site profile owns its declared deployment configuration
- a Brand Guide owns approved visual identity and voice
.envsupplies local values and bindings- manifests and lockfiles own package state
None of these override safety policy or explicit repository constraints.
Core rules
- Spec-driven: read the site profile before deploy, DNS, or branding changes.
- Dry-run first: infrastructure and Cloudflare mutations → audit → dry-run →
--apply. - Runtime artifacts: keep generated output in
Web_Toolkit/.runtime/, not in publishable source. - Discovery layer: use the established toolkit generators and
discovery-doctorwhen the client repository adopts that contract. The doctor requires the core llms/humans/security/content discovery artifacts by default; explicitly relaxed or runtime-only resources are INFO when absent, while present-but-invalid resources fail. Do not create a parallel generator. - Styles: external CSS in
src/styles/with tokens; runstylesheet-check scan --root <project>when changing UI CSS. - Accessibility: toolkit sites use
Web_Toolkit/wcag_auditor(WCAGate wrapper) only — never resolveAI/wcag-auditor. Engine isgithub:imyourboyroy/WCAGateinWeb_Toolkit/node_modules. Evidence gate — not a conformance certificate. - Assets: no stock/placeholder favicons or heroes; Astro
Image/Picture(astro:assets,imageService: 'compile'on Workers) for content photos — preferOptimizedPicturewith AVIF+WebP. image-pipeline only for leftoverpublic/rasters. SVG masters for icons/logos. - Workers-over-external: prefer Cloudflare Workers/bindings (KV, D1, R2, Vectorize) before adding SaaS.
- Version truth: verify Astro/Wrangler/Node from repo + registry — never trust stale model memory.
- Automatic freshness: toolkit entrypoints perform a throttled update check; only a clean public
maincheckout may fast-forward, while WCAGate follows its unpinned publicmaindependency. Dirty or unmanaged state is reported and preserved.
Canonical sequence (summary)
For material work without current readiness evidence, start with:
node ./Web_Toolkit/site_readiness/bin/site-readiness.mjs run --project-root <site> --site-profile <profile>See Web_Toolkit/OPERATIONS.md for the full numbered list. Short form:
- Toolkit freshness preflight (automatic; inspect
.runtime/toolkit-auto-update.jsonon warning/error) site-readiness run(orproject-init apply-safeon fresh folders)init_site_profileor load existing profile- Build:
npm run check→npm run build discovery-doctoron./distbefore deploy (with--site-profilefor the active discovery contract); again on live URL after prod- Staging deploy + smoke before production
cf-agentaudits — dry-run hardening first- Before sharing toolkit:
toolkit-purge --apply,privacy-check,toolkit-verify
Key CLI entry points
| Module | Binary |
| Cloudflare agent | Web_Toolkit/cloudflare-agent-toolkit/bin/cf-agent.mjs |
| Discovery doctor | Web_Toolkit/discovery_doctor/bin/discovery-doctor.mjs |
| WCAG auditor | Web_Toolkit/wcag_auditor/bin/wcag-auditor.mjs (wrapper; engine in Web_Toolkit/node_modules/@imyourboyroy/wcagate) |
| Project init | Web_Toolkit/project_init/bin/project-init.mjs |
| Site readiness | Web_Toolkit/site_readiness/bin/site-readiness.mjs |
| Toolkit report | Web_Toolkit/toolkit_report/bin/toolkit-report.mjs |
| Stylesheet check | Web_Toolkit/stylesheet_check/bin/stylesheet-check.mjs |
| Site doctor | Web_Toolkit/site_doctor/bin/site-doctor.mjs |
Pass --site-profile <path> whenever the target site is not the default example profile.
Verification before completion
- Site profile loaded and respected
- Dry-run outputs reviewed before any
--apply discovery-doctorpasses ondist/(and live URL if deployed)- No secrets in committed files or toolkit export
- Client project
MEMORY.mdupdated when versions/deploy change (when applicable)
Skill distribution
See docs/agent-skills/README.md
Inspect and install the selected Portable Web Toolkit skills from the repository
manifest. Check existing client skill directories first, preserve conflicts,
and change only explicitly selected clients and skills.Core: portable-web-toolkit-router (global default), site-onboarding,
portable-web-toolkit, site-readiness, site-starter, site-maintenance,
wcag-auditor, pagespeed-diagnostics, discovery-doctor, toolkit-update
Optional: brand-doctor, image-pipeline, instagram-clone,
vectorize-pipeline
Optional helper scripts default to status. Agent-driven installation remains the primary path.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
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.

