Home / apertur3 / headroom · GitHub

DESIGN.mdA

DESIGN.md from apertur3/headroom is a DESIGN.md file: the design rules coding agents follow in that repo.

Install it, pinned
mdr add apertur3/headroom/DESIGN.md@git:20261017.7bcaeec

Pins git:20261017.7bcaeec in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 14 of 14 checks passed
Kind
DESIGN.md file
Repository
apertur3/headroom
Path
DESIGN.md
Versions recorded
1
Latest version
git:20261017.7bcaeec, committed Oct 17, 2026
Size
3,031 bytes
Repository stars
16
License
a license file GitHub does not identify

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

# Design overview

For contributors. User-facing behaviour is in [README.md](README.md) and [docs/](docs/); this file is the map of the code.

## What is read, and how

- **Adapters** (`src/adapters/`): native TypeScript readers for Claude, Codex, Kimi, Grok and Antigravity (failure and no-daemon cases). Vendor credentials are read at call time from the vendor's own store or file and are not copied.
- **Native engine** (`engine/`, `src/engine/native/`): a bundled macOS reader, used for Antigravity, run through `src/engine/native/run.ts`. It is not used on Windows (`src/collector.ts`).
- **Local pools** (`src/engine/local.ts`): vLLM and llama.cpp servers.
- **Collector** (`src/collector.ts`): polls every account and turns the results into `Observation` rows (`src/types.ts`, `src/engine/observation.ts`).
- **Store** (`src/store.ts`): SQLite (`node:sqlite`), file `headroom.db` in the Headroom home. Holds observations, leases, events and spend.
- **Daemon** (`src/daemon.ts`): long-running poller that serves requests over a local socket (a named pipe on Windows).
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add apertur3/headroom/DESIGN.md@sha256:d5ff1b041654245c

The line at the top of this page pins the label git:20261017.7bcaeec, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_xfwe4z7qgirdsbbk.svg)](https://markdownregistry.com/a/art_xfwe4z7qgirdsbbk)

3 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 1 version of this file, committed on Oct 17, 2026.

versioncommittedcommitsizeaudit
git:20261017.7bcaeec latest2026-10-17 7bcaeec 3,031 BA view

Audit of the latest version

A  14 of 14 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Size between 200 bytes and 200 KB (3031 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

apertur3/headroom · 16 stars · license a license file GitHub does not identify · pushed 2026-11-03 · branch master

API

GET https://markdownregistry.com/api/v1/artifacts/art_xfwe4z7qgirdsbbk
GET https://markdownregistry.com/api/v1/resolve?ref=apertur3/headroom/DESIGN.md
GET https://markdownregistry.com/api/v1/blob/d5ff1b041654245cc1d103ca81e88835e8bdbf6b69082df4f0abb517b49f7a5f

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: what DESIGN.md is and how agents use it · which agent file does what.

More from apertur3/headroom

llms.txt llms.txt file
apertur3/headroom · llms.txt
git:20261017.7bcaeec · audit A · 16 stars
headroom SKILL.md skill
apertur3/headroom · skills/headroom/SKILL.md · Budget-aware orchestration with Headroom. Use before spawning agents, dispatching bulk work, or choosing which…
git:20261017.d8c9c9e · audit A · 16 stars

Every file in apertur3/headroom

Other files named DESIGN.md

DESIGN.md DESIGN.md file
garrytan/gstack · DESIGN.md
git:20261104.2ff2d3b · audit A · 140,694 stars
DESIGN.md DESIGN.md file
paperclipai/paperclip · DESIGN.md
git:20261105.56517dd · audit A · 111,624 stars
DESIGN.md DESIGN.md file
pbakaus/impeccable · DESIGN.md · Neo kinpaku system. Two brand anchors, kinpaku gold and verdigris patina, sit on dark warm-black lacquer. Restraint in…
git:20260721.d7d1027 · audit A · 106,186 stars
DESIGN.md DESIGN.md file
tt-a1i/archify · DESIGN.md · A precise, vivid technical instrument for trustworthy interactive architecture maps.
git:20260817.a0bc059 · audit A · 94,561 stars
DESIGN.md DESIGN.md file
heygen-com/hyperframes · DESIGN.md
git:20260408.fe9cd30 · audit A · 80,701 stars
DESIGN.md DESIGN.md file
cherryhq/cherry-studio · DESIGN.md
git:20261102.a500029 · audit A · 53,286 stars
DESIGN.md DESIGN.md file
garrytan/gbrain · DESIGN.md
git:20260519.3a0e111 · audit A · 31,587 stars
DESIGN.md DESIGN.md file
different-ai/openwork · DESIGN.md
git:20261105.74b7c70 · audit A · 24,407 stars

Browse by kind, by grade A, or by owner.