headroomlabs-ai/headroom:README 來源編輯指南
根據 README、倉庫資料與授權整理 headroomlabs-ai/headroom 的安裝與核驗路徑。
專案定位
headroomlabs-ai/headroom 的 README 將專案描述為「Compress tool outputs, logs, files, and RAG chunks before they reach the LLM. 20% fewer tokens for coding agents, 60-95% fewer tokens for JSON, same answers. Library, proxy, MCP server.」。本文只整理倉庫可直接核對的內容,不把 star、Fork 或宣傳語當成品質證明。README 在「README」下寫到:██╗ ██╗███████╗ █████╗ ██████╗ ██████╗ ██████╗ ██████╗ ███╗ ███╗ ██║ ██║██╔════╝██╔══██╗██╔══██╗██╔══██╗██╔═══██╗██╔═══██╗████╗ ████║ ███████║█████╗ ███████║██║ ██║██████╔╝██║ ██║██║ ██║██╔████╔██║ ██╔══██║██╔══╝ ██╔══██║██║ ██║██╔══██╗██║。這說明的是專案邊界,不是已完成的生產驗證。
適用場景
從 README 的「What it does」與相關條目,可以先判斷它是否處理你的實際問題:Proxy , headroom proxy --port 8787, zero code changes, any language。若需求不同,不應只因專案熱度就採用。本文保留原始專案名、命令與元件名,方便回到一手來源核對。 README 另外列出一項可核對的資訊:Library , compress(messages) in Python or TypeScript, inline in any app。這類原文條目可用來設計試跑步驟,但不能取代實際環境測試。
運作方式
README 將運作方式分散在「Get started (60 seconds)」等段落。可確認的線索包括:To use headroom, it is recommended you launch a wrapped agent session each time so that all necessary setup is completed. When wrapping a coding agent, headroom starts a local proxy, installs Serena for semantic code navigation, and。本文不把未寫出的架構、效能或安全邊界補成結論;真正的執行鏈仍要配合目錄、設定檔與版本標籤檢查。
安裝與第一次執行
第一次安裝應從 README 指出的入口開始。目前可核對的命令是: # 1 , Install uv tool install --python 3.13 "headroom-ai[all]" # CLI as a global tool in a self-contained virtual env pip install "headroom-ai[all]" # Python , ships the `headroom` CLI npm install headroom-ai # TypeScript SDK only , no `headroom` CLI # 2 , Pick your mode (the `headroom` commands below come from the uv or pip install) headroom deploy # turnkey local deployment + agent config headroom wrap claude 如果倉庫沒有命令,本文不會自行編造步驟,而是建議先閱讀「How it works (30 seconds)」,確認系統依賴、預設埠與首次初始化。
設定與日常使用
日常使用取決於專案文件。README 的「Get started (60 seconds)」段落提到:The headroom CLI ships only via the PyPI package. The npm headroom-ai is the TypeScript SDK , a library you import (import { compress } from 'headroom-ai'), not a CLI, so it provides no headroom command.。設定檔、環境變數、權限與資料目錄只在來源明確時才會記錄;沒有寫出的預設值,應在測試環境驗證並保留回滾副本。 同一部分也提到:Agent wrap , headroom wrap claude|codex|grok|copilot|cursor|aider|opencode|cline|continue|goose|openhands|openclaw|vibe|omp|zcode in one command; undo with headroom unwrap。