prb-effect AGENTS.md

Development instructions for prb-effect, a TypeScript library built with Effect-TS and managed in a multi-package repository, also called a monorepo.

In plain words
What is it for?
Use them when setting up the repository, changing packages, running Biome or TypeScript checks, and testing affected code.
Why use it?
They define the project’s required tools and checks, reducing inconsistent code and catching type, formatting, lint, or related-test failures.

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/paulrberg/prb-effect/agents-md
Clone the repo
git clone --depth 1 https://github.com/PaulRBerg/prb-effect

Made for: Codex, OpenCode.

Per session 1,516 This file is loaded in full into every session.
When invoked 1,516 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.01516 $0.01516
Opus 5 $0.00758 $0.00758
Sonnet 5 $0.00303 $0.00303
Haiku 4.5 $0.00152 $0.00152

Measured 3d ago against content hash 9842c79c5c48, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

prb-effect 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 3d ago.

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

How it starts

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

prb-effect Development Guidelines

AI agents working on prb-effect MUST follow these guidelines.

Tech Stack

  • Effect: Effect-TS v3.x
  • Language: TypeScript v5.9+
  • Package Manager: Bun with workspace catalogs
  • Task Runner: Just
  • Linter and Formatter: Biome (JS/TS/JSON), Prettier (MD/YAML)
  • Testing: Vitest with @effect/vitest

Prerequisites

  • Node.js v20+
  • Bun package manager
  • Just command runner
  • Ni package manager resolver (na, ni, nr, etc.)

Setup

git clone https://github.com/PaulRBerg/prb-effect.git
cd prb-effect
bun install

Lint Rules

After generating code, run these commands in order.

Command sequence:

  1. Biome lint — if JS/TS/JSON files changed

    • na biome lint <files>
  2. TypeScript check — if TS files changed

    • Changed code in a single package? → just type-check <package>
    • Changed code across packages? → just type-check-all
  3. Run related tests — if test files or test-related files changed

    • na vitest <test-files> — only run tests related to your changes, not the entire suite

If any command fails, fix errors before continuing.

Monorepo Structure

prb-effect/
├── evm/                 # @prb/effect-evm - EVM/viem integration
├── evm-safe/            # @prb/effect-evm-safe - Safe Apps integration
├── next/                # @prb/effect-next - Next.js integration
├── solana/              # @prb/effect-solana - Solana integration
├── xstate/              # @prb/effect-xstate - xState v5 workflows
├── justfile             # Task automation
└── package.json         # Root workspace with catalogs

Commands

just --list            # Show all available commands
just full-check          # Run all code checks (prettier + biome + type check)
just full-write          # Auto-fix formatting and linting issues
just biome-check         # Check code with Biome
just build <package>     # Build a single package (e.g., just build evm)
just build-all           # Build all packages (.tgz)
just type-check <package> # TypeScript type check a single package
just type-check-all      # TypeScript type check all packages
just tu                  # Run unit tests
just ti                  # Run integration tests
just clean               # Clean dist, tsbuildinfo, tgz artifacts
just evm::build          # Build @prb/effect-evm
just evm::test           # Test @prb/effect-evm
just evm::tui            # Run @prb/effect-evm tests in UI mode
just evm-safe::build     # Build @prb/effect-evm-safe
just next::build         # Build @prb/effect-next
just next::test          # Test @prb/effect-next
just solana::build       # Build @prb/effect-solana
just xstate::build       # Build @prb/effect-xstate

Read the full file on GitHub · 161 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. 3d ago First seen · 161 lines · 1,516 tokens per session scan A 9842c79c5c48

Subscribe to this mod's changes

prb-effect AGENTS.md is an instructions file published in the GitHub repository PaulRBerg/prb-effect (22 stars, last pushed 29d ago), licensed MIT. It adds 1,516 tokens to every session, about $0.0076 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.

Related

Other instructions, from other repositories

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

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

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

next.js 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