本速查覆盖全书后半本用到的命令、配置与环境变量。全部条目基于 v0.41.0,写法示意,以官方文档为准——尤其子命令名、参数名与环境变量名,升级版本后必须逐项核对(第 11.1 节清单)。
# install_headroom.sh —— 安装姿势(基于 v0.41.0,写法示意,以官方文档为准) pip install headroom==0.41.0 # 精确锁定版本(0.x 纪律) pip install "headroom[onnx]" # 可选依赖组:本地推理等 extras 名称以官方文档为准
依赖环境变量(第 11.2 节):
| 变量 | 用途 | 备注 |
|---|---|---|
| HF_ENDPOINT | HF 模型下载镜像 | 解决网络慢与不通 |
| HF_HUB_OFFLINE | 离线模式,设 1 生效 | 需预置本地模型缓存 |
| HEADROOM_BEACON | 匿名遥测开关,off 关闭 | 默认开,须显式决策入档 |
# wrap_commands.sh —— 一键接入与撤销(基于 v0.41.0,写法示意,以官方文档为准) headroom wrap claude-code # 包装 Claude Code;zcode、codex、grok 等同理 headroom wrap --list # 查看受支持名单与已包装状态 headroom unwrap claude-code # 撤销包装并还原配置 headroom proxy --port 8787 # 启动本地转发进程;应用改指向该地址即可
18 个受支持 Agent(官方口径,v0.41.0):Claude Code、Codex、Grok、Cursor(手动)、Aider、Copilot CLI、Copilot VS Code、OpenClaw、OpenCode、Cline、Continue、Goose、OpenHands、Mistral Vibe、Oh My Pi、Kimi CLI、Cortex Code、ZCode。
# observe_and_bench.sh —— 观测四件套与基准(基于 v0.41.0,写法示意,以官方文档为准) headroom savings # 累计节省读数 headroom dashboard # 面板 headroom perf # 压缩层性能开销 headroom doctor # 环境与依赖体检(排错第一现场) headroom bench --seed 20260902 --scenario sre-debug # 复现四场景基准(场景名示意)
四场景基准读数(官方自测口径):代码搜索 21%、SRE 调试 57%、代码库探索 42%、issue 分诊 30%。
# headroom_cache.yaml —— 缓存协同配置(基于 v0.41.0,写法示意,以官方文档为准) compression: mode: cache # 缓存协同模式:live-zone 追加式压缩 live_zone: true # 新增字节先压缩再并入冻结前缀 cache_aligner: enabled: true # 只标记易变内容,从不改写 prompt telemetry: prometheus: true # 指标输出供第 10 章观测
# output_shaper.sh —— 输出侧治理总开关(默认关) export HEADROOM_OUTPUT_SHAPER=1 # 开启 verbosity steering + effort routing
| 集成点 | 形态 | 侵入度 | 详见 |
|---|---|---|---|
| OpenAI / Anthropic | withHeadroom 包装客户端 | 调用级 | 第 7.3 节 |
| Vercel AI SDK | middleware | 调用级 | 第 7.3 节 |
| LiteLLM | 单 callback 注册 | 网关级 | 第 7.3 节 |
| LangChain / LangGraph | 模型边界挂载 | 编排级 | 第 7.3 节 |
| Agno / Strands / CrewAI / AutoGen | 框架接缝 | 编排级 | 第 7.3 节 |
| ASGI 服务 | CompressionMiddleware | 路由级 | 第 7.2 节 |
| 现成 Agent | wrap / proxy | 配置级 | 第 7.1、7.2 节 |
# memory_commands.sh —— 记忆与学习(基于 v0.41.0,写法示意,以官方文档为准) headroom learn --dry-run # 挖掘失败会话,只出候选纠正清单 headroom learn --write agents-md # 人审通过后写入指定项目记忆文件(参数示意)
项目记忆文件四个落点:CLAUDE.local.md(个人本地)、CLAUDE.md(Claude 系共享)、AGENTS.md(跨工具通用)、GEMINI.md(Gemini 系)。
wrap 联装 Serena(语义代码导航,可关闭)。Headroom 自身提供 MCP 工具族,其中检索工具为 headroom_retrieve;工具族完整名单与启用方式以官方文档为准。