instructor CLAUDE.md

A development guide for Instructor, a Python project, covering setup, testing, type checking, code style, coverage, and MkDocs documentation.

In plain words
What is it for?
Use it when installing dependencies, running or filtering tests, checking types, linting, formatting, measuring coverage, or building the documentation.
Why use it?
It gathers the project's expected commands and setup steps in one place, reducing inconsistent environments and incomplete checks.

Instructions file

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/567-labs/instructor/claude-md
Clone the repo
git clone --depth 1 https://github.com/567-labs/instructor
Per session 3,148 This file is loaded in full into every session.
When invoked 3,148 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.03148 $0.03148
Opus 5 $0.01574 $0.01574
Sonnet 5 $0.00630 $0.00630
Haiku 4.5 $0.00315 $0.00315

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

Security

Grade A, and why

instructor CLAUDE.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.

CLAUDE.md · 304 lines

How it starts

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

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Instructor Development Guide

Commands

  • Install deps: uv pip install -e ".[dev,anthropic]" or poetry install --with dev,anthropic
  • Run tests: uv run pytest tests/ -n auto
  • Run specific test: uv run pytest tests/path_to_test.py::test_name
  • Skip LLM tests: uv run pytest tests/ -k 'not llm and not openai'
  • Type check: uv run ty check
  • Lint: uv run ruff check instructor examples tests
  • Format: uv run ruff format instructor examples tests
  • Generate coverage: uv run coverage run -m pytest tests/ -k "not docs" then uv run coverage report
  • Build documentation: uv run mkdocs serve (for local preview) or ./build_mkdocs.sh (for production)
  • Waiting: use sleep <seconds> for explicit pauses (e.g., CI waits) or to let external processes finish

Installation & Setup

  • Fork the repository and clone your fork
  • Install UV: pip install uv
  • Create virtual environment: uv venv
  • Install dependencies: uv pip install -e ".[dev]"
  • Install pre-commit: uv run pre-commit install
  • Run tests to verify: uv run pytest tests/ -k "not openai"

Code Style Guidelines

  • Typing: Use strict typing with annotations for all functions and variables
  • Imports: Standard lib → third-party → local imports
  • Formatting: Follow Black's formatting conventions (enforced by Ruff)
  • Models: Define structured outputs as Pydantic BaseModel subclasses
  • Naming: snake_case for functions/variables, PascalCase for classes
  • Error Handling: Use custom exceptions from exceptions.py, validate with Pydantic
  • Comments: Docstrings for public functions, inline comments for complex logic

Conventional Commits

  • Format: type(scope): description
  • Types: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert
  • Examples:
    • feat(anthropic): add support for Claude 3.5
    • fix(openai): correct response parsing for streaming
    • docs(README): update installation instructions
    • test(gemini): add validation tests for JSON mode

Read the full file on GitHub · 304 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 · 304 lines · 3,148 tokens per session scan A 374feaaccf38

Subscribe to this mod's changes

instructor CLAUDE.md is an instructions file published in the GitHub repository 567-labs/instructor (13,803 stars, last pushed 3d ago), licensed MIT. It adds 3,148 tokens to every session, about $0.0157 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