Files
headroom/wiki/cli.md
02c4e922f7 fix(cli): resolve active proxy port for read commands (#3522)
## Description

`headroom wrap copilot` can intentionally start a dedicated proxy on
port 8788
(or fall forward when 8787 is busy), but read-only CLI commands
previously
defaulted directly to 8787. As a result, `headroom dashboard` could open
a dead
or unrelated dashboard even though the wrapped session reported its
proxy on
8788.

This change extends the shared `headroom/cli/port_discovery.py` resolver
(introduced by #3855) to include live wrap-client markers, preferring
the
newest healthy session while preserving explicit `--port` and
`HEADROOM_PORT`
overrides.

Closes: N/A (no matching open issue found)

## Type of Change

- [x] Bug fix (non-breaking change that fixes an issue)
- [ ] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
- [x] Documentation update
- [ ] Performance improvement
- [ ] Code refactoring (no functional changes)

## Changes Made

- Extended the shared port discovery module from #3855 with live
wrap-client
marker validation (PID liveness and reuse checks), newest-session
ordering,
  and `/health` verification.
- Updated `dashboard`, `inspect`, and the runtime probe used by `learn`
to
  follow the newest healthy live wrap session after explicit and
  `HEADROOM_PORT` overrides.
- Kept `doctor`'s requested-port behavior; it now reports a healthy
proxy
  discovered from wrap-client markers elsewhere, with a `--port` hint.
- Added a warning when `dashboard` cannot reach the resolved port.
- Exported the actual proxy port as `HEADROOM_PORT` into every wrapped
agent
  environment.
- Reused #3855's port-discovery module rather than introducing a
parallel
  resolver.
- Added regression coverage for stale/recycled markers, multiple
sessions,
  explicit/environment overrides, dashboard output, doctor diagnostics,
  inspect/learn routing, and wrapped child environments.
- Documented automatic discovery and wrong-port troubleshooting.

## Testing

- [x] Unit tests pass (`pytest`)
- [x] Linting passes (`ruff check .`)
- [x] Type checking passes (`mypy headroom`)
- [x] New tests added for new functionality
- [x] Manual testing performed

### Test Output

```text
$ uv run pytest tests/test_cli/test_proxy_port_discovery.py \
    tests/test_cli/test_dashboard_port_discovery.py \
    tests/test_cli/test_port_alignment.py \
    tests/test_cli/test_wrap_helpers.py \
    tests/test_cli_doctor.py tests/test_cli_inspect.py tests/test_cli_learn.py -q
267 passed in 5.49s

$ uv run ruff check .
All checks passed!

$ uv run ruff format --check .
1677 files already formatted

$ uv run mypy headroom/cli/port_discovery.py headroom/cli/proxy.py \
    headroom/cli/doctor.py headroom/cli/inspect.py headroom/cli/learn.py
Success: no issues found in 5 source files

$ uv run pre-commit run --all-files
Sync plugin versions.....................................................Passed
Verify Ruff version alignment............................................Passed
check for merge conflicts................................................Passed
ruff (legacy alias)......................................................Passed
ruff format..............................................................Passed
mypy.....................................................................Passed
```

After the first rebase, `make ci-precheck` completed `cargo fmt --check`
and
`cargo clippy --workspace -- -D warnings`, then stalled in the existing
Rust
Magika/detection tests (multiple tests exceeded 60 seconds). The same
stall
recurred during the push hook; it was stopped after confirming the
affected
suite. The final rebase onto #3883 was followed by the Python/CLI
regression
suite and all repository pre-commit gates above, but not another Rust
test run.

## Real Behavior Proof

- Environment: Ubuntu 22.04.5 LTS x86_64; Python 3.10.12; uv 0.12.10;
Headroom proxy 0.40.0-dev, started on isolated port 18788 with an
isolated live-client marker.
- Exact command / steps: Started an isolated process that wrote its live
PID marker and launched `headroom proxy --port 18788` under a temporary
workspace, with `HEADROOM_PORT` unset; then ran `env -u HEADROOM_PORT -u
HEADROOM_PORT_DISCOVERY
HEADROOM_WORKSPACE_DIR=/tmp/headroom-port-discovery-proof-20260930/workspace
./.venv/bin/headroom dashboard --no-open` and curled
`http://127.0.0.1:18788/dashboard`.

```text
$ env -u HEADROOM_PORT -u HEADROOM_PORT_DISCOVERY \
    HEADROOM_WORKSPACE_DIR=/tmp/headroom-port-discovery-proof-20260930/workspace \
    ./.venv/bin/headroom dashboard --no-open
  Detected live proxy on port 18788
  Dashboard: http://127.0.0.1:18788/dashboard

$ curl --max-time 5 -sS -o /dev/null -w '%{http_code}\n' \
    http://127.0.0.1:18788/dashboard
200

# Proxy health before discovery returned:
service=headroom-proxy status=healthy ready=true
```

- Observed result: With `HEADROOM_PORT` unset, the CLI selected the
marker-associated healthy proxy on 18788, printed the matching dashboard
URL, and the endpoint returned HTTP 200. The earlier manual run with a
real wrapped Copilot session also confirmed discovery on 8788 before
this rebase.
- Not tested: Starting a new interactive `wrap copilot` session after
this rebase (avoided launching an agent); Windows/macOS PID-identity
behavior; multiple simultaneous real proxies; browser UI launch. Unit
tests cover marker ordering, PID reuse, and explicit/environment
overrides.

## Runtime Rollout Safety

- Rollout-managed feature(s): None.
- Minimum rollout channel: N/A.
- Stable/default behavior changed: `dashboard`, `inspect`, and `learn`
now follow
the newest healthy live wrap proxy when no port override is set;
`doctor`
remains on the requested/default port and reports a live proxy
elsewhere.
- Kill switch / disable path: Pass `--port`, set `HEADROOM_PORT`, or set
  `HEADROOM_PORT_DISCOVERY=0` to bypass automatic discovery.
- Unsafe override required: No.
- Qualification impact: None.
- Rollback path: Revert this commit; commands return to the fixed 8787
default.

## Review Readiness

- [x] I have performed a self-review
- [x] This PR is ready for human review

## Checklist

- [x] My code follows the project's style guidelines
- [x] I have performed a self-review of my code
- [x] I have commented my code, particularly in hard-to-understand areas
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [x] I have added tests that prove my fix is effective or that my
feature works
- [x] New and existing unit tests pass locally with my changes
- [x] I did **not** edit `CHANGELOG.md` — it is generated by
release-please from
  my Conventional Commit PR title

## Screenshots (if applicable)

N/A — terminal output above captures the behavior.

## Additional Notes

Port discovery is integrated into #3855's shared `port_discovery.py`;
candidates
are accepted only when `/health` identifies `service: headroom-proxy`,
so an
unrelated local JSON service cannot be mistaken for a Headroom proxy.

<!-- devin-review-badge-begin -->

---

<a href="https://app.devin.ai/review/headroomlabs-ai/headroom/pull/3522"
target="_blank"><picture><source media="(prefers-color-scheme: dark)"
srcset="https://static.devin.ai/assets/gh-devin-review-dark.svg?v=4"><img
src="https://static.devin.ai/assets/gh-devin-review-light.svg?v=4"
alt="Devin Review"></picture></a>
<!-- devin-review-badge-end -->

### Maintainer current-main requalification

Exact head `e66a6393f83278aa07e9965f5b87fed820603677`, upstream main
`2d3ee51846435ef5b320eea4806af14e602b0d8c`.

Re-reviewed latest integration head 420c2d636 and current author
response, including isolated workspace/port fixtures and live-marker
ordering/pruning regressions. Clean integration with upstream/main
2d3ee51846. Explicit CLI ports and
HEADROOM_PORT retain precedence; discovery bounds candidate probes,
verifies Headroom health identity, prefers newest live wrap markers, and
preserves configured-agent discovery. No new PR-specific correctness
blocker found in scope.

All 436
dashboard/port/discovery/wrap/doctor/inspect/learn/release/version/MCP
tests pass. All 14 changed Python files pass Ruff check/format;
whitespace passes. Previous cached-read freeze-boundary failure was
independently reproduced on main and is not a contributor-code blocker.
Maintainers handle fresh exact-head qualification and distinguish
inherited failures; no contributor CI execution requested. Existing
native extension supported startup, not a fresh native build. No
contributor discovery logic rewritten; nothing merged.


Exact-head hosted checks are being handled by maintainers. No new
finding in the reviewed scope; formal approval awaits exact-head hosted
qualification; nothing merged.

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: JerrettDavis <mxjerrett@gmail.com>
2026-11-05 21:10:06 -06:00

36 KiB

CLI Reference

This page is the authoritative reference for the Python Headroom CLI exposed by the headroom console script.

Audit note (2026-09-02): headroom --help on this branch lists 30 top-level commands; this page documents 15 of them and omits agent-savings, audit-reads, capture, copilot-auth, dashboard, deploy, diff, doctor, init, loc, output-savings, recover, rollout, savings, sg, tools, and update entirely. The headroom proxy and headroom install apply option tables below are similarly stale — proxy --help alone now runs to ~90 options vs. the ~30 documented here. Treat the command list and captured --help blocks in this file as historical snapshots, not current reference; verify against headroom <cmd> --help before relying on any option in this file. See the audit report for detail.

Global behavior

Entry points

  • Console script: headroom
  • Python module entrypoint: python -m headroom.cli

Global options

Option Scope Meaning
--help, -? root, groups, commands Show help and exit
--version, -v root only Show the Headroom version and exit

-v is a root-level version alias. Inside subcommands such as headroom wrap claude -v, -v keeps its subcommand meaning (--verbose), not version.

Command index

Command Purpose Docker-native parity
headroom install ... Install and manage persistent deployments python-native; Docker-native wrapper supports persistent-docker lifecycle subset
headroom proxy Run the Headroom proxy server native in container
headroom learn Learn from past tool-call failures native in container
headroom perf Summarize recent proxy performance native in container
headroom inspect Show original vs compressed content for recent requests native in container
headroom evals ... Run memory evaluation workflows native in container
headroom memory ... Inspect and manage stored memories native in container
headroom mcp ... Install, inspect, remove, or serve MCP integration native in container
headroom wrap claude Start proxy and launch Claude Code host-bridged
headroom wrap copilot Start proxy and launch GitHub Copilot CLI python-native only
headroom wrap codex Start proxy and launch Codex CLI host-bridged
headroom wrap aider Start proxy and launch Aider host-bridged
headroom wrap cursor Start proxy and print Cursor config guidance host-bridged
headroom wrap openclaw Install and configure the OpenClaw plugin host-bridged
headroom unwrap openclaw Disable the Headroom OpenClaw plugin host-bridged

Captured --help output

The sections below capture the current top-level help output from the live CLI.

headroom --help

Usage: headroom [OPTIONS] COMMAND [ARGS]...

  Headroom - The Context Optimization Layer for LLM Applications.

  Manage memories, run the optimization proxy, and analyze metrics.

  Examples:
      headroom proxy              Start the optimization proxy
      headroom memory list        List stored memories
      headroom memory stats       Show memory statistics
      headroom update             Update Headroom to the latest release

Options:
  -v, --version  Show the version and exit.
  -?, --help     Show this message and exit.

Commands:
  agent-savings   Render or verify Codex/Claude/Cursor token-savings...
  audit-reads     Audit Read-tool traffic for compression opportunities.
  capture         Capture and compare network traffic for Headroom...
  copilot-auth    Manage Headroom's GitHub Copilot OAuth token.
  dashboard       Open the Headroom savings dashboard in your browser.
  deploy          Deploy a turnkey local Headroom proxy and configure...
  diff            Run difftastic (structural diff).
  doctor          Check that the Headroom proxy and client routing are...
  evals           Evaluation commands (memory, compression robustness,...
  init            Install durable Headroom integrations for supported...
  inspect         Show original vs compressed content for recent proxy...
  install         Install and manage persistent Headroom deployments.
  learn           Learn from past tool call failures to prevent future ones.
  loc             Run scc (fast lines-of-code / repo-shape probe).
  mcp             MCP server for Claude Code integration.
  memory          Manage memories stored in Headroom.
  output-savings  Show estimated/measured output-token reduction from the...
  perf            Analyze proxy performance from logs.
  proxy           Start the optimization proxy server.
  recover         Recover agent state left in a temporary Headroom home.
  rollout         Inspect runtime feature-rollout policy (not package...
  savings         Show durable compression savings over time.
  sg              Run ast-grep (AST-aware structural search/replace).
  tools           Manage bundled CLI tool binaries (ast-grep, difft, scc).
  unwrap          Undo durable Headroom wrapping for supported tools.
  update          Update Headroom to the latest release.
  wrap            Wrap CLI tools to run through Headroom.

Captured from headroom --help on this branch, 2026-09-02 (headroom/cli/main.py, per-command modules under headroom/cli/). None of agent-savings, audit-reads, capture, copilot-auth, dashboard, deploy, diff, doctor, init, loc, output-savings, recover, rollout, savings, sg, tools, or update is documented elsewhere in this file.

Top-level command help snapshots

headroom proxy --help
Usage: headroom proxy [OPTIONS]

  Start the optimization proxy server.

  Examples:
      headroom proxy                    Start proxy on port 8787
      headroom proxy --port 8080        Start proxy on port 8080
      headroom proxy --no-optimize      Passthrough mode (no optimization)

  Usage with Claude Code:
      ANTHROPIC_BASE_URL=http://localhost:8787 claude

  Usage with OpenAI-compatible clients:
      OPENAI_BASE_URL=http://localhost:8787/v1 your-app
headroom learn --help
Usage: headroom learn [OPTIONS]

  Learn from past tool call failures to prevent future ones.
headroom perf --help
Usage: headroom perf [OPTIONS]

  Analyze proxy performance from logs.
headroom evals --help
Usage: headroom evals [OPTIONS] COMMAND [ARGS]...

  Memory evaluation commands.

Commands:
  memory     Run LoCoMo memory evaluation benchmark.
  memory-v2  Run LoCoMo V2 evaluation with LLM-controlled memory tools.
headroom memory --help
Usage: headroom memory [OPTIONS] COMMAND [ARGS]...

  Manage memories stored in Headroom.

Commands:
  delete  Delete one or more memories by ID.
  edit    Edit a memory's content or importance.
  export  Export all memories to JSON.
  import  Import memories from a JSON file.
  list    List stored memories with optional filters.
  prune   Prune memories matching specified criteria.
  purge   Delete ALL memories from the database.
  show    Show full details of a single memory.
  stats   Show memory store statistics.
headroom mcp --help
Usage: headroom mcp [OPTIONS] COMMAND [ARGS]...

  MCP server for Claude Code integration.

Commands:
  install    Install Headroom MCP server into Claude Code config.
  serve      Start the MCP server (called by Claude Code).
  status     Check Headroom MCP configuration status.
  uninstall  Remove Headroom MCP server from Claude Code config.
headroom install --help
Usage: headroom install [OPTIONS] COMMAND [ARGS]...

  Install and manage persistent Headroom deployments.

Options:
  -?, --help  Show this message and exit.

Commands:
  apply    Install a persistent Headroom deployment.
  remove   Remove a persistent deployment and undo managed config.
  restart  Restart a persistent deployment.
  start    Start a persistent deployment.
  status   Show persistent deployment status.
  stop     Stop a persistent deployment.
headroom wrap --help
Usage: headroom wrap [OPTIONS] COMMAND [ARGS]...

  Wrap CLI tools to run through Headroom.

Commands:
  aider     Launch aider through Headroom proxy.
  claude    Launch Claude Code through Headroom proxy.
  copilot   Launch GitHub Copilot CLI through Headroom proxy.
  codex     Launch OpenAI Codex CLI through Headroom proxy.
  cursor    Start Headroom proxy for use with Cursor.
  openclaw  Install and configure Headroom OpenClaw plugin in one command.
headroom unwrap --help
Usage: headroom unwrap [OPTIONS] COMMAND [ARGS]...

  Undo durable Headroom wrapping for supported tools.

Commands:
  openclaw  Disable the Headroom OpenClaw plugin and restore the legacy engine slot.

headroom proxy

Start the optimization proxy server.

headroom proxy
headroom proxy --port 8787
headroom proxy --mode cache
Option Default Meaning
--host 127.0.0.1 Host interface to bind
--port, -p 8787 Port to bind
--mode runtime default Optimization mode: token, cache, token_mode, cache_mode, token_savings, cost_savings, token_headroom
--no-optimize off Disable optimization and operate in passthrough mode
--no-cache off Disable semantic caching
--no-rate-limit off Disable rate limiting
--retry-max-attempts runtime default 3 Maximum upstream retry attempts
--request-timeout-seconds runtime default 300 Request timeout in seconds
--connect-timeout-seconds runtime default 10 Upstream connection timeout
--anthropic-pre-upstream-concurrency auto max(2, min(8, cpu_count)) Cap simultaneous pre-upstream work on /v1/messages (body read, deep copy, first compression stage, memory-context lookup, upstream connect). 0 or negative disables (unbounded); any positive integer is honoured verbatim. Prevents cold-start replay storms from starving /livez, /readyz, and new Codex WS opens.
--anthropic-pre-upstream-acquire-timeout-seconds 15.0 Fail fast when the Anthropic pre-upstream queue is saturated. Requests that wait longer return 503 with Retry-After instead of parking indefinitely.
--anthropic-pre-upstream-memory-context-timeout-seconds 2.0 Fail-open timeout for Anthropic memory-context lookup while the request still holds a pre-upstream slot.
--log-file unset JSONL log output path
--budget unset Daily USD budget limit
--no-code-aware off Disable AST-aware code compression
--code-aware off Enable code-aware compression in the proxy (env: HEADROOM_CODE_AWARE_ENABLED)
--no-read-lifecycle off Disable stale/superseded read compression
--no-ccr off Disable CCR entirely — no retrieval markers in content and no injected headroom_retrieve tool (lossy, no recovery path)
--no-ccr-proactive-expansion off Disable proactive CCR context expansion
--memory off Enable persistent user memory
--memory-db-path "" Override memory DB path (help text: {cwd}/.headroom/memory.db)
--no-memory-tools off Disable automatic memory tool injection
--no-memory-context off Disable automatic memory context injection
--memory-top-k 10 Number of memories to inject
--learn off Enable live traffic learning
--no-learn off Explicitly disable traffic learning
--backend anthropic Backend: anthropic, bedrock, openrouter, anyllm, or litellm-*
--anyllm-provider openai Provider name for anyllm
--anthropic-api-url unset Custom Anthropic passthrough API URL
--openai-api-url unset Custom OpenAI passthrough API URL
--anthropic-extra-headers unset JSON object of extra headers merged into (and overriding) forwarded Anthropic requests
--openai-extra-headers unset JSON object of extra headers merged into (and overriding) forwarded OpenAI requests
--gemini-api-url unset Custom Gemini passthrough API URL
--region us-west-2 Cloud region for Bedrock / Vertex / related backends
--bedrock-region unset Deprecated Bedrock region override
--bedrock-profile unset AWS profile name for Bedrock
--telemetry off Opt in to anonymous usage telemetry (off by default)
--no-telemetry off Force anonymous usage telemetry off (already the default)

Notes:

  • --learn implies memory unless --no-learn is also set.
  • Proxy startup can also read environment variables such as HEADROOM_HOST, HEADROOM_PORT, HEADROOM_BUDGET, HEADROOM_MODE, HEADROOM_ANYLLM_PROVIDER, HEADROOM_ANTHROPIC_PRE_UPSTREAM_CONCURRENCY, HEADROOM_ANTHROPIC_PRE_UPSTREAM_ACQUIRE_TIMEOUT_SECONDS, HEADROOM_REQUEST_TIMEOUT, HEADROOM_ANTHROPIC_PRE_UPSTREAM_MEMORY_CONTEXT_TIMEOUT_SECONDS, ANTHROPIC_TARGET_API_URL, OPENAI_TARGET_API_URL, GEMINI_TARGET_API_URL, ANTHROPIC_TARGET_API_HEADERS, and OPENAI_TARGET_API_HEADERS. CLI flags take precedence over environment variables.
  • The default Anthropic pre-upstream cap is intentionally conservative for CPU/ONNX-heavy work. Larger containers may want to raise it after checking the resolved runtime values on /readyz or /debug/warmup.

See also: Proxy Server, Configuration

headroom learn

Learn from past tool-call failures and produce agent guidance.

headroom learn
headroom learn --apply
headroom learn --agent codex --all
Option Default Meaning
--project current project resolution Target project path
--all off Analyze all discovered projects
--apply off Write recommendations instead of dry-run output
--agent auto Agent source: auto, built-ins (claude, codex, gemini), or plugin-provided names
--model auto-detect LLM model used for analysis

Notes:

  • --agent auto scans all detected agent data sources.
  • If --project is omitted, Headroom resolves from the current directory upward.
  • External agent integrations register through the headroom.learn_plugin entry point.

See also: Failure Learning

headroom perf

Summarize recent proxy performance from the local proxy log.

headroom perf
headroom perf --hours 24
headroom perf --raw
Option Default Meaning
--hours 168.0 Time window in hours
--raw off Print raw PERF records instead of the summarized report

The command reads each per-port runtime log ${HEADROOM_WORKSPACE_DIR}/logs/proxy-<port>.log (defaults to ~/.headroom/logs/) plus PID-qualified files from multi-worker deployments, aggregating them while still reading a legacy proxy.log when present — see the Filesystem Contract).

headroom inspect

Show the original vs compressed content for recent requests so you can see what the compressor changed (not just the token counts). Useful for building trust in compression and debugging quality regressions.

headroom inspect                 # inspect the most recent request
headroom inspect --last 5        # inspect the 5 most recent requests
headroom inspect --full          # include unchanged messages
headroom inspect --format json   # raw feed for piping into another tool
Option Default Meaning
--port / -p auto-detected, else 8787 Proxy port to query. Defaults to the most recently started live wrap session (env: HEADROOM_PORT)
--last 1 Number of most-recent requests to show
--format text text renders a highlighted diff; json emits the raw feed
--full off Include messages the compressor left unchanged

inspect queries the running proxy's loopback /transformations/feed endpoint, so the proxy must be started with --log-messages (or --log-file) for the pre/post-compression snapshots to be captured.

headroom evals

Memory evaluation command group.

headroom evals memory

Run the LoCoMo memory evaluation benchmark.

headroom evals memory -n 3
headroom evals memory --answer-model gpt-4o --llm-judge
Option Default Meaning
--n-conversations, -n all available Number of conversations to evaluate
--categories benchmark default Comma-separated categories
--include-adversarial off Include category 5 / unanswerable questions
--top-k 10 Memories retrieved per question
--f1-threshold 0.5 Threshold for correctness
--answer-model unset Model for answer generation
--llm-judge off Use LLM-as-judge scoring
--judge-provider litellm Judge provider: openai, anthropic, litellm, simple
--judge-model gpt-4o Judge model
--output, -o unset Save JSON results to a path
--no-extract off Disable LLM memory extraction
--extraction-model gpt-4o-mini Memory extraction model
--pass-all off Require all checks to pass
--parallel 10 Parallel worker count
--debug off Enable debug output

headroom evals memory-v2

Run the V2 memory evaluation flow with LLM-controlled tools.

headroom evals memory-v2
headroom evals memory-v2 --save-model gpt-4o-mini --llm-judge
Option Default Meaning
--n-conversations, -n all available Number of conversations to evaluate
--categories benchmark default Comma-separated categories
--include-adversarial off Include adversarial questions
--f1-threshold 0.5 Threshold for correctness
--save-model gpt-4o-mini Model used when persisting memories
--answer-model gpt-4o Answer model
--max-results 10 Maximum tool results
--no-graph off Disable graph usage
--llm-judge off Use LLM-as-judge scoring
--judge-model gpt-4o Judge model
--output, -o unset Save JSON results
--parallel 5 Parallel worker count
--debug off Enable debug output

Hidden compatibility shims exist for older command paths:

  • headroom memory-eval
  • headroom memory-eval-v2

These are intentionally omitted from normal usage docs.

headroom memory

Memory management command group. This group is only registered when the optional memory dependencies import successfully.

headroom memory list

headroom memory list
headroom memory list --scope USER --since 7d
headroom memory list -q "budget"
Option Default Meaning
--db-path ./.headroom/memory.db if present, else ~/.headroom/memory.db Memory database path
--limit, -n 50 Maximum memories to show
--session, -s unset Filter by session ID
--scope unset USER, SESSION, AGENT, or TURN
--since unset Age filter using duration syntax such as 7d, 2w, 1m
--search, -q unset Content search query

headroom memory show <memory_id>

headroom memory show 1234abcd
headroom memory show 1234abcd --json
Argument / option Default Meaning
memory_id required Full or partial memory ID
--db-path ./.headroom/memory.db if present, else ~/.headroom/memory.db Memory database path
--json off Emit raw JSON

headroom memory stats

headroom memory stats
Option Default Meaning
--db-path ./.headroom/memory.db if present, else ~/.headroom/memory.db Memory database path

headroom memory edit <memory_id>

headroom memory edit 1234abcd --content "Updated note"
headroom memory edit 1234abcd --importance 0.9
Argument / option Default Meaning
memory_id required Full or partial memory ID
--db-path ./.headroom/memory.db if present, else ~/.headroom/memory.db Memory database path
--content, -c unset New memory content
--importance, -i unset New importance score (0.0 to 1.0)

At least one of --content or --importance is required.

headroom memory delete <memory_ids...>

headroom memory delete 1234abcd 5678efgh
headroom memory delete 1234abcd --force
Argument / option Default Meaning
memory_ids... required One or more memory IDs
--db-path ./.headroom/memory.db if present, else ~/.headroom/memory.db Memory database path
--force, -f off Skip confirmation

headroom memory prune

headroom memory prune --older-than 30d --dry-run
headroom memory prune --scope SESSION --force
Option Default Meaning
--db-path ./.headroom/memory.db if present, else ~/.headroom/memory.db Memory database path
--older-than unset Age threshold
--scope unset Scope filter: USER, SESSION, AGENT, TURN
--low-importance unset Importance cutoff
--session, -s unset Session ID filter
--dry-run off Show what would be removed
--force, -f off Skip confirmation

At least one filter is required. Filters combine with AND semantics.

headroom memory purge

headroom memory purge --confirm
Option Default Meaning
--db-path ./.headroom/memory.db if present, else ~/.headroom/memory.db Memory database path
--confirm off Required confirmation flag

headroom memory export

headroom memory export
headroom memory export --output export.json
Option Default Meaning
--db-path ./.headroom/memory.db if present, else ~/.headroom/memory.db Memory database path
--output, -o stdout Output path

headroom memory import <file>

headroom memory import export.json
headroom memory import export.json --force
Argument / option Default Meaning
file required JSON file containing exported memories
--db-path ./.headroom/memory.db if present, else ~/.headroom/memory.db Memory database path
--force, -f off Skip confirmation

The import expects a JSON array. Malformed entries are skipped.

headroom mcp

Manage the Headroom MCP server integration.

headroom mcp install

headroom mcp install
headroom mcp install --proxy-url http://127.0.0.1:9000
Option Default Meaning
--proxy-url http://127.0.0.1:8787 Proxy URL written into MCP config
--force off Overwrite an existing Headroom MCP config

headroom mcp uninstall

headroom mcp uninstall

This removes the Headroom MCP server entry from the Claude configuration.

headroom mcp status

headroom mcp status

This inspects MCP SDK availability, Claude config state, and proxy reachability.

headroom mcp serve

headroom mcp serve
headroom mcp serve --proxy-url http://127.0.0.1:9000 --debug
Option Default Meaning
--proxy-url http://127.0.0.1:8787 Proxy URL (also reads HEADROOM_PROXY_URL)
--direct off Disable stdio transport wrapping
--debug off Enable debug logging

serve is part of the public CLI, but it is usually consumed by MCP host tooling rather than by humans directly.

See also: MCP Tools

headroom install

Install and manage persistent local Headroom deployments.

headroom install apply --help

Usage: headroom install apply [OPTIONS]

  Install a persistent Headroom deployment.

Options:
  --preset [persistent-service|persistent-task|persistent-docker]
                                  Persistent runtime preset to install.
                                  [default: persistent-service]
  --runtime [python|docker]       Runtime used to execute Headroom for
                                  service/task modes.  [default: python]
  --scope [provider|user|system]  Where to apply persistent configuration.
                                  [default: user]
  --providers [auto|all|manual]   Target selection mode for direct tool
                                  configuration.  [default: auto]
  --target [claude|copilot|codex|aider|cursor|openclaw]
                                  Tool target to configure when --providers
                                  manual is used.
  --profile TEXT                  Deployment profile name.  [default: default]
  -p, --port INTEGER              Persistent proxy port.  [default: 8787]
  --backend TEXT                  Proxy backend for the persistent runtime.
                                  [default: anthropic]
  --anyllm-provider TEXT          Provider for any-llm backends when --backend
                                  anyllm is used.
  --region TEXT                   Cloud region for Bedrock / Vertex style
                                  backends.
  --mode TEXT                     Proxy optimization mode.  [default: token]
  --memory                        Enable persistent memory in the proxy runtime.
  --telemetry                     Opt in to anonymous telemetry in the runtime
                                  (off by default).
  --no-telemetry                  Force anonymous telemetry off in the runtime
                                  (already the default).
  --image TEXT                    Docker image to use when runtime=docker or
                                  preset=persistent-docker.  [default:
                                  ghcr.io/headroomlabs-ai/headroom:latest]
  -?, --help                      Show this message and exit.

headroom install apply

headroom install apply --preset persistent-service --providers auto
headroom install apply --preset persistent-task --providers manual --target claude --target codex
headroom install apply --preset persistent-docker --scope user
Option Default Meaning
--preset persistent-service Lifecycle preset: persistent-service, persistent-task, or persistent-docker
--runtime python Runtime used for service/task installs: python or docker
--scope user Config scope: provider, user, or system
--providers auto Target selection mode: auto, all, or manual
--target repeatable Tool target used with --providers manual
--profile default Deployment profile name
--port, -p 8787 Persistent proxy port
--backend anthropic Backend for the managed runtime
--anyllm-provider unset Provider name used with --backend anyllm
--region unset Cloud region override
--mode token Proxy optimization mode
--memory off Enable persistent memory in the managed runtime
--telemetry off Opt in to anonymous telemetry (off by default)
--no-telemetry off Force anonymous telemetry off (already the default)
--image ghcr.io/headroomlabs-ai/headroom:latest Docker image for Docker-backed installs

apply stores a manifest under ${HEADROOM_WORKSPACE_DIR}/deploy/<profile>/manifest.json (default ~/.headroom/deploy/<profile>/manifest.json), applies managed tool configuration, starts the chosen runtime, and waits for readyz.

Docker-native host wrappers expose a narrower headroom install subset for persistent-docker only: apply, status, start, stop, restart, and remove. Those wrapper flows preserve the same port and manifest behavior, but they intentionally reject persistent-service, persistent-task, and provider mutation flags like --scope, --providers, and --target.

headroom install status

headroom install status
headroom install status --profile default

Shows the stored profile, preset, runtime, supervisor kind, scope, port, runtime status, readiness, and backend from /health.

headroom install start

headroom install start
headroom install start --profile default

Starts a previously installed deployment profile without reapplying mutations.

headroom install stop

headroom install stop

Stops the managed runtime for an installed deployment profile.

headroom install restart

headroom install restart

Stops and starts the selected deployment profile.

headroom install remove

headroom install remove

Stops the runtime, removes installed supervisor artifacts, reverts managed configuration changes, and deletes the stored manifest.

See also: Persistent Installs

headroom wrap

Wrap external coding tools so their traffic flows through Headroom.

Shared semantics

  • --port, when available, defaults to 8787
  • --no-proxy skips proxy startup and assumes an existing proxy
  • --learn enables live traffic learning
  • -v, --verbose means verbose output
  • Hidden --prepare-only exists for internal Docker-native bridge flows and is intentionally omitted from normal usage

headroom wrap claude

headroom wrap claude
headroom wrap claude --resume <session-id>
headroom wrap claude --port 9999
Option / arg Default Meaning
--port, -p 8787 Proxy port
--no-proxy off Reuse an existing proxy
--learn off Enable live traffic learning
--verbose, -v off Verbose output
claude_args... passthrough Additional Claude Code arguments

Requires the claude binary on the host.

headroom wrap codex

headroom wrap codex
headroom wrap codex -- "fix the bug"
headroom wrap codex --backend anyllm --anyllm-provider groq
Option / arg Default Meaning
--port, -p 8787 Proxy port
--no-proxy off Reuse an existing proxy
--learn off Enable live traffic learning
--backend unset Proxy backend override
--anyllm-provider unset anyllm provider override
--region unset Cloud region override
--verbose, -v off Verbose output
codex_args... passthrough Additional Codex CLI arguments

Requires the codex binary on the host.

headroom wrap copilot

headroom wrap copilot -- --model claude-sonnet-4-20250514
headroom wrap copilot --backend anyllm --anyllm-provider groq -- --model gpt-4o
Option / arg Default Meaning
--port, -p 8787 Proxy port
--no-proxy off Reuse an existing proxy
--learn off Enable live traffic learning
--backend unset Proxy backend override
--anyllm-provider unset anyllm provider override
--region unset Cloud region override
--provider-type auto Force Copilot BYOK provider type (anthropic or openai)
--wire-api unset OpenAI wire API override for OpenAI-style backends
--verbose, -v off Verbose output
copilot_args... passthrough Additional Copilot CLI arguments

Requires the copilot binary on the host. When a matching persistent deployment exists on the requested port, wrap copilot reuses or recovers it before falling back to an ephemeral proxy.

headroom wrap aider

headroom wrap aider
headroom wrap aider -- --model gpt-4o
headroom wrap aider --backend litellm-vertex --region us-central1
Option / arg Default Meaning
--port, -p 8787 Proxy port
--no-proxy off Reuse an existing proxy
--learn off Enable live traffic learning
--backend unset Proxy backend override
--anyllm-provider unset anyllm provider override
--region unset Cloud region override
--verbose, -v off Verbose output
aider_args... passthrough Additional Aider arguments

Requires the aider binary on the host.

headroom wrap cursor

headroom wrap cursor
headroom wrap cursor --port 9999
Option Default Meaning
--port, -p 8787 Proxy port
--no-proxy off Reuse an existing proxy
--learn off Enable live traffic learning
--verbose, -v off Verbose output

This command prints Cursor configuration instructions and waits while the proxy stays up. It does not launch Cursor directly.

headroom wrap openclaw

headroom wrap openclaw
headroom wrap openclaw --plugin-path ./plugins/openclaw
Option Default Meaning
--plugin-path unset Local plugin source directory
--plugin-spec headroom-ai/openclaw NPM plugin spec
--skip-build off Skip local npm install / build steps
--copy off Copy plugin instead of linked install
--proxy-port 8787 Headroom proxy port
--startup-timeout-ms 20000 Proxy startup timeout
--gateway-provider-id repeatable OpenClaw provider IDs routed through Headroom
--python-path unset Python launcher override
--no-auto-start off Disable plugin auto-start behavior
--no-restart off Do not restart the OpenClaw gateway
--verbose, -v off Verbose output

Requires the openclaw binary on the host, and local-source mode may also require npm. In Docker-native mode, the installed host wrapper drives the host openclaw CLI while the plugin auto-starts the host headroom wrapper from PATH.

headroom unwrap

Undo durable wrapping for supported tools.

headroom unwrap openclaw

headroom unwrap openclaw
headroom unwrap openclaw --no-restart
Option Default Meaning
--no-restart off Do not restart the OpenClaw gateway
--verbose, -v off Verbose output

This disables the Headroom OpenClaw plugin and restores the legacy context engine slot.

Docker-native parity matrix

This matrix compares the Python CLI contract to the Docker-native host wrapper added in this branch.

Legend:

  • native in container — the command runs entirely inside the Headroom container
  • host-bridged — Headroom runs in Docker, but the wrapped external tool still runs on the host
Command path Python CLI Docker-native wrapper Parity
headroom proxy native native in container full
headroom learn native native in container full
headroom perf native native in container full
headroom evals memory native native in container full
headroom evals memory-v2 native native in container full
headroom memory ... native (when memory deps are available) native in container full
headroom mcp install native native in container full
headroom mcp uninstall native native in container full
headroom mcp status native native in container full
headroom mcp serve native native in container full
`headroom install apply status start stop
headroom wrap claude native host-bridged partial
headroom wrap copilot native not implemented in Docker-native wrapper none
headroom wrap codex native host-bridged partial
headroom wrap aider native host-bridged partial
headroom wrap cursor native host-bridged partial
headroom wrap openclaw native host-bridged partial
headroom unwrap openclaw native host-bridged partial

For the Docker-native execution model itself, see Docker-Native Install. For persistent service/task/docker lifecycle management, see Persistent Installs.

Hidden and compatibility-only command paths

These exist in code but are intentionally excluded from normal user docs:

  • headroom memory-eval
  • headroom memory-eval-v2
  • hidden internal --prepare-only flags on wrap subcommands

If you are documenting operational behavior or debugging internal wrapper flows, refer to the implementation in headroom/cli/wrap.py.