webjs AGENTS.md

Project instructions for WebJs that act as a working agreement for AI agents and developers changing the app.

In plain words
What is it for?
Use them before and during WebJs work to find the right reference documentation and follow the project's coding and verification rules.
Why use it?
They keep branch handling, worktrees, routing, components, data actions, authentication, and styling consistent across changes.

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

Made for: Codex, OpenCode.

Per session 28,819 This file is loaded in full into every session.
When invoked 28,819 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.28819 $0.28819
Opus 5 $0.14410 $0.14410
Sonnet 5 $0.05764 $0.05764
Haiku 4.5 $0.02882 $0.02882

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

Security

Grade A, and why

webjs 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 yesterday.

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

How it starts

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

AGENTS.md for WebJs

This file is the contract for AI agents (and humans) editing a WebJs app. It describes file conventions, the public API, invariants to preserve, and recipes for common tasks. Keep it in sync whenever behaviour changes.

Detail docs, loaded when relevant. They don't auto-load. This file stays lean on purpose; anything marked "see the skill" has the full reference there.

The full reference is the skill at .agents/skills/webjs/SKILL.md, which routes to these references/:

Reference Topic
references/routing-and-pages.md Pages, layouts, dynamic routes, route handlers, metadata, redirects, 404s
references/components.md Writing components: what a component owns, reactive props, signals, lifecycle, light vs shadow DOM, inherited members not to shadow
references/data-and-actions.md Server actions, mutations, queries, validation, the ActionResult envelope, Drizzle surface, where server-derived types live
references/auth-and-sessions.md Sessions, login flows, route protection, forbidden() / unauthorized()
references/styling.md Tailwind, light-DOM tag-prefix rule, tokens, fixed headers, no-reflow layout
references/client-router-and-streaming.md Client router, prefetch, frames, view transitions, Suspense streaming
references/optimistic-ui.md Optimistic UI for a user-facing mutation
references/typescript.md TypeScript at runtime, erasable syntax, full-stack types, the derive-the-type rule (never unknown / any)
references/testing.md Unit, browser, e2e tests, the handle() harness, Bun parity
references/built-ins.md Auth, caching, env vars, rate limit, file storage, the webjs config block
references/runtime.md Node vs Bun, running the app, deploying, runtime-specific differences
references/service-worker.md Offline support, an asset cache, the opt-in service worker
references/module-structure.md Module size (target 800, ceiling around 1000), SOLID / DRY / KISS as judgment, and the procedure for barrelling a large module into a directory
references/muscle-memory-gotchas.md READ FIRST when writing components or routes. Next.js / Lit patterns that break WebJs, with the webjs-shaped fix for each

Repo-root framework-dev.md covers monorepo dev (only when editing WebJs itself): commands, repo-health git config, changelog flow, dev error overlay.


Read the full file on GitHub · 691 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. yesterday First seen · 691 lines · 28,819 tokens per session scan A 842afc75d6f3

Subscribe to this mod's changes

webjs AGENTS.md is an instructions file published in the GitHub repository webjsdev/webjs (109 stars, last pushed 10d ago), licensed MIT. It adds 28,819 tokens to every session, about $0.1441 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-08-30.