命令列
devbroom 把 App 的掃描帶到終端機:同樣的判定,同樣的理由。掃描不刪除、不搬移、不更動任何東西;清理是另一個獨立的指令。
devbroom clean 做的事和 App 的「清理」按鈕一樣:先顯示可清理的內容,詢問後再移到垃圾桶。你在 App 中設定的保護在這裡同樣適用。安裝
devbroom 就在 App 裡面,不需另外安裝。在「設定 › 代理與整合」中按下「連結 devbroom」,指令就會被連結為 ~/.local/bin/devbroom。如果 App 不在「應用程式」資料夾中,請先把它移過去,否則連結會失效。然後打開新的終端機視窗,檢查版本。
$ devbroom --versiondevbroom 0.1.0
如果 ~/.local/bin 不在你 shell 的 PATH 中,請用完整路徑執行指令,或把該資料夾加入 PATH。
用法
devbroom [scan] [PATH...] [options]devbroom clean [PATH...] [--dry-run] [--delete] [--include-review PATH]... [--yes] [--json]devbroom status [--json]devbroom mcpdevbroom compat
不指定路徑時,會掃描目前所在的資料夾。你可以指定多個路徑。主資料夾中代理的資料每次掃描都會包含。
$ devbroom # 目前所在的資料夾$ devbroom ~/projects ~/work # 多個資料夾$ devbroom ~/projects --details # 附上每條理由$ devbroom ~/projects --all # 全部列出,而不只是最大的
選項
| 選項 | 作用 |
|---|---|
-d, --details |
顯示每個判定背後的每條理由。 |
-a, --all |
列出找到的每一項,而不只是最大的。 |
--json |
以 JSON 輸出完整報告。 |
--no-color |
關閉顏色。設定了 NO_COLOR 時也不使用顏色。 |
-h, --help |
顯示說明。 |
-V, --version |
顯示版本。 |
-- |
把其後的所有內容都當作路徑:devbroom -- -odd-folder |
未知的選項會產生錯誤,而且不會掃描任何東西。
清理
devbroom clean 會掃描、根據可清理的內容產生新的計畫、顯示計畫,並且只有在你同意後才把這些資料夾移到垃圾桶。它做過的事會出現在 App 的「歷史紀錄」中;如果 App 中已有清理正在進行,它不會等待,而是直接結束。
$ devbroom clean ~/projects --dry-run # 只顯示$ devbroom clean ~/projects # 顯示、詢問、移到垃圾桶
| 選項 | 作用 |
|---|---|
-n, --dry-run |
顯示計畫,不更動任何東西。 |
--delete |
永久刪除,而不是移到垃圾桶。如果你的組織關閉了永久刪除,則無法使用。 |
--include-review PATH |
把一個需查看的項目加入計畫;相當於 App 中的「仍要加入」。會在終端機中要求確認,不能與 --yes 一起使用。可以指定多次。 |
-y, --yes |
不經詢問直接清理。 |
--json |
以 JSON 輸出計畫和結果。 |
不指定路徑時,它會使用你在 App 中選擇的資料夾;如果從未設定過 App,則使用目前所在的資料夾。clean 只清理建置資料夾、代理的暫存資料夾和快取;worktree 和代理資料要在 App 中清理。
沒有可供詢問的終端機,或指定了 --yes 時,它會更嚴格:只因為專案自己的 .devbroom.toml 而被判定為可清理的項目不會進入計畫,因為這個檔案可能是代理寫的。既沒有終端機也沒有 --yes 時,什麼都不會改變。
狀態
devbroom status 顯示 App 的上次掃描,不會重新掃描:有多少可清理、幾分鐘前掃描的,以及最大的可清理項目。--json 以 JSON 提供同樣的內容。如果 App 還沒掃描過,會產生錯誤。
為代理提供 MCP
devbroom mcp 是一個 MCP 伺服器。Claude Code、Codex 或 Cursor 可以讀取上次掃描、詢問某個資料夾為什麼是可清理或已鎖定,並請你清理;請求會在 App 中交給你,它從不自行清理任何東西。設定方式請見整合頁面。
看懂輸出
報告以英文撰寫,分為四個部分。每一行都以該項的判定開頭。
$ devbroom ~/projectsDevbroom scan (read-only) ~/projects in 22.4sAgent data on this Mac Claude Code 2.1.288 37.8 GB 297 sessions, 2 running Codex 0.159.2 746 MB 41 sessions Orca 1.4.215 528 MBCleanup potential READY 19.7 GB 56 items every check passed REVIEW 16.9 GB 39 items worth a look before cleaning BLOCKED 19.1 GB 5 items in use or holding work
- Agent data on this Mac
- 這台 Mac 上的代理:版本、佔用空間、工作階段數、其中多少對應已不存在的資料夾,以及多少正在執行。
- Cleanup potential
- 每種判定的總大小和項目數。
- Worktrees
- 每個 worktree 的建議操作(
remove、prune、repair)及其判定。 - Largest items
- 最大的項目及其理由。
--all會全部顯示。
判定
命令列使用 App 的四種判定,以大寫書寫。
| 輸出中 | 意思 |
|---|---|
| READY可清理 | 這項操作的所有檢查都已通過。 |
| REVIEW需查看 | 已知的風險,或只有你才能做的決定;例如一個被忽略的 .env 檔案。 |
| BLOCKED已鎖定 | 正在使用、受到保護,或含有 git 會拒絕丟棄的工作。 |
| UNKNOWN不確定 | 證據不足。永遠不會算作可清理。 |
JSON 輸出
--json 會輸出完整報告,適合腳本和持續整合。格式以 schema_version 欄位標示版本,目前為 1。要求 JSON 時不會輸出進度行。
$ devbroom ~/projects --json > report.json$ head -3 report.json{ "schema_version": 1, …
相容性
devbroom compat 顯示 Devbroom 測試過哪些代理版本,以及你的 Mac 上安裝了哪些版本。
Claude Code tested: 2.1.0 to 2.1.292 here: 2.1.288 · verifiedCodex tested: 0.115.0 to 0.159.2 here: 0.159.2 · verifiedCursor tested: none yet here: not on this MacOpenCode tested: none yet here: not on this MacOrca tested: 1.4.0 to 1.4.221 here: 1.4.215 · verified
如果你的版本超出測試範圍,但代理的檔案符合預期格式,Devbroom 仍可正常使用,並顯示為「尚未測試」。如果格式不符,該代理的資料只會讀取;其中任何內容都不算可清理。
結束代碼
| 代碼 | 意思 |
|---|---|
0 |
完成。 |
1 |
失敗。 |
2 |
用法錯誤:未知的選項,或路徑不是資料夾。 |
3 |
clean:未確認,沒有更動任何東西。 |
4 |
clean:部分完成。 |
5 |
clean:另一個清理正在進行。 |
6 |
clean:你所屬組織的政策不允許。 |
130 |
已取消(Ctrl-C)。 |
Ctrl-C 會停止掃描;再按一次 Ctrl-C 會立即結束。
環境變數
| 變數 | 作用 |
|---|---|
NO_COLOR |
設定後,輸出不帶顏色。 |
CLAUDE_CONFIG_DIR |
如果 Claude Code 的設定資料夾不在 ~/.claude,就從這裡讀取。 |
CLAUDE_CODE_TMPDIR |
如果你搬移了 Claude Code 的暫存資料夾,就從這裡讀取。 |
CODEX_HOME |
如果 Codex 的資料夾不在 ~/.codex,就從這裡讀取。 |
CURSOR_CONFIG_DIR |
如果 Cursor 的資料夾不在 ~/.cursor,就從這裡讀取。 |
XDG_DATA_HOME, XDG_CACHE_HOME, OPENCODE_DB |
如果 OpenCode 的資料和資料庫在別處,就從這些位置讀取。 |
最後更新: 2026年10月7日