What is kaitai_struct_awkward_runtime AGENTS.md?

A guide for a Python package that works with Kaitai Struct, a tool that turns binary-data descriptions into code for reading files or network formats. It covers the package, generated C++ test files, compiled libraries, compiler setup, and tests.

Use it when installing dependencies, updating the Python runtime, working with Kaitai schemas, compiling C++ test artifacts, running tests, or checking code quality.

It explains the several languages and build tools involved, reducing setup mistakes when changing the parser or its generated-code tests.

How det-lab/kaitai_struct_awkward_runtime configures Codex and OpenCod

Reuse

Borrowing it

Nothing to install: this file belongs to det-lab/kaitai_struct_awkward_runtime. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/det-lab/kaitai_struct_awkward_runtime/main/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/det-lab/kaitai_struct_awkward_runtime

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/det-lab/kaitai_struct_awkward_runtime/agents-md/github.svg)](https://agentmods.dev/instructions/det-lab/kaitai_struct_awkward_runtime/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/det-lab/kaitai_struct_awkward_runtime/agents-md"><img src="https://agentmods.dev/badge/instructions/det-lab/kaitai_struct_awkward_runtime/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/det-lab/kaitai_struct_awkward_runtime/agents-md"><img src="https://agentmods.dev/badge/instructions/det-lab/kaitai_struct_awkward_runtime/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 995 This file is loaded in full into every session.

When invoked 995 The same file — it is already loaded in full.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

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.

Model	Per session	Once invoked
Fable 5.1	$0.00995	$0.00995
Opus 5.5	$0.00398	$0.00398
Sonnet 5.5	$0.00199	$0.00199
Haiku 4.5	$0.00100	$0.00100

Measured 2mo ago against content hash 88dfab438888, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

kaitai_struct_awkward_runtime 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 2mo 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 · 61 lines

How it starts

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

Repository Guidelines

Project Structure & Module Organization

src/awkward_kaitai/: Python package (runtime, builder, reader, data). Public API lives here.
tests/: Pytest suite (test_*.py) plus JSON fixtures.
example_data/schemas/: Kaitai .ksy schemas used to generate C++ sources.
test_artifacts/: Generated .cpp files and compiled .so libraries (build outputs).
kaitai_struct_compiler/: Kaitai Struct compiler submodule (Scala/SBT build).
docs/, mkdocs.yml: Documentation site content and configuration.

Setup & Dependencies

Initialize submodules first: git submodule update --init --recursive.
Toolchain: Java + SBT for the compiler, CMake + C++ toolchain for building shared libs, Python 3.8+.
Kaitai compiler requirement: kaitai-struct-compiler 0.11+ with the awkward target.

Build, Test, and Development Commands

pip install -e . installs the package in editable mode.
nox -s lint runs pre-commit hooks across the repo.
nox -s pylint runs pylint on the package.
nox -s tests runs the pytest suite.
make test builds C++ test artifacts and runs all tests.
make compile_test testcase=hello_world rebuilds a single schema and runs its test.
make clean removes local/, build/, and test_artifacts/ outputs.

Makefile Workflow (Detailed)

Prereqs: Java + SBT for kaitai_struct_compiler/, plus a working C++ toolchain and Python env.
make cpp builds Scala compiler jars (via SBT) and generates test_artifacts/*.cpp from example_data/schemas/*.ksy.
make test runs the full pipeline: compile compiler → generate C++ → build shared libs test_artifacts/lib*.so → pytest.
make compile_test testcase=<name> is the fast loop for a single schema (<name> must match a file in example_data/schemas/).
make clean wipes generated artifacts and SBT build products; rerun make test after cleaning.

Coding Style & Naming Conventions

Python formatting and linting are enforced by pre-commit (Black, Ruff, mypy, codespell).
Indentation is 4 spaces; keep line length flexible (Ruff ignores E501).
Tests are named tests/test_*.py (enforced by pre-commit).
Prefer from __future__ import annotations for new modules (Ruff isort rule).

Read the full file on GitHub · 61 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.

2mo ago First seen · 61 lines · 995 tokens per session scan A 88dfab438888

Subscribe to this mod's changes

kaitai_struct_awkward_runtime AGENTS.md is an instructions file published in the GitHub repository det-lab/kaitai_struct_awkward_runtime (2 stars, last pushed 1mo ago), licensed MIT. It adds 995 tokens to every session, about $0.0040 per session on Opus 5.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-31.

kaitai_struct_awkward_runtime AGENTS.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
kaitai_struct_awkward_runtime AGENTS.mddet-lab/kaitai_struct_awkward_runtime	Instructions file	2	1mo ago	MIT	A	995	Codex, OpenCode
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	today	MIT	A	7,461	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	5,649	GitHub Copilot
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	today	MIT	A	4,680	Codex, OpenCode
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	3,093	GitHub Copilot
vscode model-prompts.instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	2,022	GitHub Copilot

kaitai_struct_awkward_runtime: Instructions file for Codex