orb AGENTS.md

A project-specific guide for AI coding agents and developers working on the Orb Rust codebase. It explains the workspace layout, Rust version requirements, and key build and test commands.

In plain words
What is it for?
Use it when building, testing, linting, or modifying Orb and its Rust packages, especially before submitting changes.
Why use it?
It reduces guesswork about how the repository is organised and which rules matter before changing code. It also highlights outdated documentation that could otherwise cause setup or review problems.

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

Made for: Codex, OpenCode.

Per session 1,810 This file is loaded in full into every session.
When invoked 1,810 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.01810 $0.01810
Opus 5 $0.00905 $0.00905
Sonnet 5 $0.00362 $0.00362
Haiku 4.5 $0.00181 $0.00181

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

Security

Grade A, and why

orb 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 · 171 lines

How it starts

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

Agent Guide for Orb

This file provides guidance specifically for AI agents (and humans) working on this codebase. Read AGENTS.md first for full architecture, project structure, and design principles. This file supplements it with practical details, gotchas, and quick references.

Quick Start

make build    # Debug build (fast, use for iterating)
make test     # Run all tests
make lint     # Check formatting + clippy (CI runs this)
make fix      # Auto-fix formatting + clippy issues

Always run make lint before submitting changes. CI will reject PRs that fail lint.

Rust Edition & Toolchain

  • Edition: Rust 2024 (edition = "2024" in all Cargo.toml files)
  • MSRV: 1.91 (set in all three package Cargo.toml files)
  • No rust-toolchain.toml - uses whatever stable/beta toolchain the developer has installed
  • Note: CONTRIBUTING.md says "Rust 1.90 (nightly)" — this is outdated. The actual MSRV is 1.91 from Cargo.toml.

Workspace Structure

Cargo.toml              # Workspace root (resolver = "2")
packages/
  orb-cli/              # Binary: `orb` (publish = false)
  orb-client/           # Library (publish = false, designed as standalone)
  orb-mockhttp/         # Mock server library (publish = true)

Critical Rules

1. Client/CLI Separation

orb-client must NEVER import from or depend on orb-cli. This is the most important architectural constraint.

  • Adding verbose output? Add a new ClientEvent variant in packages/orb-client/src/events.rs, then handle it in packages/orb-cli/src/verbose_events.rs.
  • Adding error handling? Use OrbError variants in orb-client, map to user-friendly messages via fatal! in orb-cli.
  • Never use fatal! in orb-client — it's a CLI macro. Use OrbError and propagate with ?.

2. Crypto Provider

Both orb-client and orb-mockhttp use aws-lc-rs as the TLS crypto provider:

let _ = rustls::crypto::aws_lc_rs::default_provider().install_default();

Read the full file on GitHub · 171 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 · 171 lines · 1,810 tokens per session scan A cc91f3ae5346

Subscribe to this mod's changes

orb AGENTS.md is an instructions file published in the GitHub repository WalshyDev/orb (11 stars, last pushed 5mo ago), licensed MIT. It adds 1,810 tokens to every session, about $0.0090 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

igniter-js GEMINI.md

Gemini CLI instructions for felipebarcelospro/igniter-js, covering 1. identity and profile, 2. about the igniter.js monorepo, 3. personality and communication, 4. lia's core responsibilities (the 4 pillars) and 5. technical guidelines and methodology.

felipebarcelospro/igniter-js · 9,239 tokens

igniter-js AGENTS.md

AGENTS.md instructions for felipebarcelospro/igniter-js, covering lia - ai agent for igniter.js, 1. identity & mission, core mission, key responsibilities and 2. project overview.

felipebarcelospro/igniter-js · 6,319 tokens

igniter-js writing-style.instructions.md

Instructions for felipebarcelospro/igniter-js, covering ✍️ unified documentation style guide (for llms & authors), 🎯 core style principles (applies to all documentation), 📘 documentation (docs): writing style, installation and quick start.

felipebarcelospro/igniter-js · 3,722 tokens

moclojer AGENTS.md

Instructions for moclojer/moclojer, covering agents.md, project overview, development commands, run the server and run all tests.

moclojer/moclojer · 3,547 tokens

igniter-js writing-guidelines.instructions.md

Instructions for felipebarcelospro/igniter-js, covering writing guidelines for humans and llms, core style principles, fumadocs-specific guidelines, available mdx components and component usage examples.

felipebarcelospro/igniter-js · 6,725 tokens

moclojer copilot-instructions.md

Instructions for moclojer/moclojer, a project described as: Simple and efficient HTTP and Webscoket mock server with specification in yaml, edn or OpenAPI.

moclojer/moclojer · 4 tokens