crabbox AGENTS.md

A repository instruction set for Crabbox, a tool that runs and tests software remotely. It explains the project layout, coding boundaries, and commands for building and testing its Go CLI and Cloudflare Worker.

In plain words
What is it for?
Use it when an agent needs to inspect, modify, build, test, or document the Crabbox repository.
Why use it?
It gives coding agents the project rules and structure they need before changing files. This reduces edits to generated files, project-specific references, or the wrong part of the system.

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

Made for: Codex, OpenCode.

Per session 1,336 This file is loaded in full into every session.
When invoked 1,336 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.01336 $0.01336
Opus 5 $0.00668 $0.00668
Sonnet 5 $0.00267 $0.00267
Haiku 4.5 $0.00134 $0.00134

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

Security

Grade A, and why

crabbox 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 2d 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 · 56 lines

How it starts

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

Repository Guidelines

Project Structure & Module Organization

Crabbox is a Go CLI plus a Cloudflare Worker coordinator. The CLI entrypoint is cmd/crabbox, with implementation and Go tests in internal/cli. Worker source lives in worker/src, with Vitest tests in worker/test. Documentation lives in docs/; command docs are under docs/commands, and feature notes under docs/features. Release configuration is in .goreleaser.yaml; GitHub Actions live in .github/workflows. Generated outputs such as bin/, dist/, worker/dist/, and worker/node_modules/ should not be edited by hand.

Product Positioning

Crabbox is a generic remote software testing and execution tool. New code, docs, tests, and examples should not mention OpenClaw, Peter, or other project/person-specific workflows unless the file is explicitly about legacy compatibility or release history. Prefer neutral examples such as example-org, [email protected], my-app, test:live, and generic repository workflows.

Architecture Boundaries

Keep core provider-neutral. Core may pass generic request/lease context and call provider capabilities for defaults, access, provision, images, release, cleanup, and diagnostics. Provider-specific reconciliation, firewall/security-group semantics, labels, snapshots, hosts, regions, rollout compatibility, and resource naming live behind provider adapters. No provider == aws/gcp/... logic in core unless it is unavoidable routing/config glue and no provider hook fits.

Build, Test, and Development Commands

  • go build -trimpath -o bin/crabbox ./cmd/crabbox: build the local CLI.
  • go vet ./...: run Go static checks.
  • go test -race ./...: run the Go test suite with the race detector.
  • gofmt -w $(git ls-files '*.go'): format Go files.
  • npm ci --prefix worker: install Worker dependencies.
  • npm run format:check --prefix worker: verify TypeScript formatting.
  • npm run lint --prefix worker: run oxlint.
  • npm run check --prefix worker: run TypeScript typechecking.
  • npm test --prefix worker: run Vitest tests.
  • npm run build --prefix worker: dry-run the Worker build through Wrangler.
  • node scripts/build-docs-site.mjs: generate the docs site into dist/docs-site.

Read the full file on GitHub · 56 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. 2d ago First seen · 56 lines · 1,336 tokens per session scan A ee9ba19045be

Subscribe to this mod's changes

crabbox AGENTS.md is an instructions file published in the GitHub repository openclaw/crabbox (1,343 stars, last pushed 2d ago), licensed MIT. It adds 1,336 tokens to every session, about $0.0067 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