instro AGENTS.md

Repository instructions for Instro that tell coding assistants how to work with the project, including commands, layout, naming rules, checks, tests, and package builds.

In plain words
What is it for?
Use them to install dependencies, run Python and Rust checks and tests, build workspace packages, and understand the codebase structure before editing.
Why use it?
They give an unfamiliar coding assistant the project-specific context needed to run the right checks and follow the repository’s conventions.

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

Made for: Codex, OpenCode.

Per session 5,769 This file is loaded in full into every session.
When invoked 5,769 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.05769 $0.05769
Opus 5 $0.02884 $0.02884
Sonnet 5 $0.01154 $0.01154
Haiku 4.5 $0.00577 $0.00577

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

Security

Grade A, and why

instro 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 · 172 lines

How it starts

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

AGENTS.md

Context for AI coding tools (Claude Code, Cursor, OpenAI Codex CLI, GitHub Copilot Workspace, Aider, etc.) working in this repo. Human contributors should read CONTRIBUTING.md instead. This file is dense on purpose.

Quick reference

uv sync --extra all              # install everything
uv sync --extra <name>           # install one optional package (daq, labjack, nidaq, mccdaq, i2c, aardvark)
just check                       # all lints: python (ruff format, mypy, ruff lint) + Rust (rustfmt, clippy, lockfiles)
just test                        # all tests: python + Rust; no hardware required
just check-python / check-rust   # single-language lints (check-rust includes lockfile + standalone-crate checks)
just test-python / test-rust     # single-language tests
uv build --package <name>        # build a wheel for a workspace package

If just check and just test both pass, CI will pass. (A separate scheduled workflow, .github/workflows/latest-deps-test.yml, additionally re-resolves dependencies to the latest versions pyproject.toml allows and re-runs the Python tests to catch upstream breaking releases; it is not part of PR CI.)

just check-python needs only just + uv. just check and just test additionally need a full native toolchain (Rust, CMake, a C compiler, and LLVM/libclang) because they run clippy/cargo test across the Rust workspace — including the instro-opcua crate's C build of open62541-sys — and just test builds the EtherNet/IP maturin wheel. See Prerequisites in CONTRIBUTING.md for per-OS install commands.

Codebase layout

The instro repository is a shared uv/cargo workspace. The top-level python package is instro, with pure-Python & mixed-Rust/Python workspace members live under packages/. All Rust workspace members live in crates/. Mixed Rust/Python crates should live in packages/.

Workspace Path What it is
Python/uv instro/<category>/ Category code: HAL class (InstroPSU, InstroDMM, …), types.py, the base driver class (PSUDriverBase, etc.). Categories: psu, dmm, eload, scope, daq, i2c, modbus.
Python/uv instro/<category>/drivers/ Concrete vendor drivers, one file per vendor/model family. Registered in drivers/__init__.py.
Python/uv instro/lib/transports/ Transport drivers (VisaDriver). Category bases are transport-agnostic; concrete drivers compose transports.
Python/uv packages/instro-contrib/ Community-contributed drivers. Mirrors core layout under instro/contrib/.
Python/uv packages/instro-unstable/ In-development categories and abstractions whose API isn't settled.
Python/uv packages/instro-{daq-ni,daq-labjack,daq-mcc,i2c-aardvark} Vendor packages wrapping proprietary native SDKs.
Python/uv tests/<category>/ Per-category tests, predominantly mocked-transport unit tests.
Rust/cargo crates/<category> Pure-Rust drivers/utilities (e.g. instro-ethernetip). Mixed Rust/Python crates with an entrypoint exposed by the instro python package should not live here.

Read the full file on GitHub · 172 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 · 172 lines · 5,769 tokens per session scan A 339a8fbaa10f

Subscribe to this mod's changes

instro AGENTS.md is an instructions file published in the GitHub repository nominal-io/instro (664 stars, last pushed 3d ago), licensed Apache-2.0. It adds 5,769 tokens to every session, about $0.0288 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

dwf-mcp-server CLAUDE.md

Instructions for KenosInc/dwf-mcp-server, covering claude.md, what this is, commands, install for development (creates .venv from uv.lock) and refresh uv.lock when pyproject.toml dependencies change.

KenosInc/dwf-mcp-server · 1,606 tokens

rigol-dho824-mcp CLAUDE.md

Instructions for aimoda/rigol-dho824-mcp, covering claude instructions, reference manuals, mcp tool design philosophy, good design example and good: single tool provides complete functionality.

aimoda/rigol-dho824-mcp · 1,862 tokens

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