Skip to main content

headroom
headroom
Capture · Install · CLI reference · Bounds · Troubleshooting

MIT license Zero dependencies Python 3.9 or newer

Claude Code and Codex enforce rolling usage limits but show the numbers only to a human, so the model never sees them and can keep working right up to the wall. headroom captures those readings and warns the model when it should conserve usage.

Install and first run

The package is not published yet. Once it is published, the shortest path will be:

uv tool install headroom-cli
headroom init
headroom status

Until then, run one of these from a clone:

uv tool install .
pip install -e .

Then run headroom init and headroom status. See the installation guide for safe previews and the plain-clone fallback.

Example output

headroom status reports every source and window:

Claude
  5h: 12% used [ok], resets in 1h 59m
  7d: unavailable
Codex
  5h: unavailable
  7d: >=94% used [critical], resets in 1h 59m

Near a limit, the prompt hook gives the model a short action:

Usage headroom: Codex weekly >=94% used (reading 1h 0m old), resets in 1h 59m.
Stop parallel subagent fan-out, use cheaper models, and checkpoint work now.

Documentation

Document What it covers
CLI reference Every command, flag, environment variable, state file, and exit code.
Why the bounds are sound Fresh, stale, and post-reset readings, reset validation, and severity.
How capture works Claude statusline input, Codex app-server RPC, and rollout fallback.
Installation guide Published and clone installs, safe init previews, backups, and fallback commands.
Troubleshooting Unavailable or stale readings, unknown resets, doctor output, and state reset.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

headroom_cli-0.1.0.tar.gz (37.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

headroom_cli-0.1.0-py3-none-any.whl (24.1 kB view details)

Uploaded Python 3

File details

Details for the file headroom_cli-0.1.0.tar.gz.

File metadata

  • Download URL: headroom_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 37.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.26 {"installer":{"name":"uv","version":"0.11.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for headroom_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 77d81c2b3e9450c778692544ef4b5130b0e1bfa2012588af02874bc30c5321c7
MD5 c61da3c2a4a8432beb13b259fa8e2d79
BLAKE2b-256 982038bf41ba7d380be212f57b9733464da7e77cabfb4a8ef2ca7fa5292737bd

See more details on using hashes here.

File details

Details for the file headroom_cli-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: headroom_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 24.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.26 {"installer":{"name":"uv","version":"0.11.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for headroom_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a9753ebcf1cba52a7887becaacbc7bc28f050420f529a9fa726d87bf4357be7d
MD5 1695890edb3448860b583262512ec922
BLAKE2b-256 f16690e3bbcb0525fa136879d96245c97f669dc3aef57c8bf743d309ff5243e0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page