-j 或 --json 以輸出機器可讀的 JSON 格式。
BRICKS Foundation 管理(bricks device)
bricks device list
列出工作區中的所有裝置。
bricks device get <id>
顯示裝置的詳細資訊,包含硬體規格。
bricks device bind <passcode>
使用通行碼將新裝置綁定至工作區。
bricks device control <id> <type>
傳送控制事件至裝置。
bricks device refresh <id>
重新載入裝置上的應用程式。
bricks device clear-cache <id>
清除裝置上的快取。
bricks device screenshot <id>
擷取螢幕截圖並儲存至本機。
bricks device monitor
即時監控裝置狀態。需要互動式終端機。
BRICKS Foundation 群組(bricks group)
bricks group list
列出所有裝置群組。
bricks group get <id>
顯示群組詳細資訊。
bricks group devices <id>
列出群組中的裝置及其線上/離線狀態。
bricks group dispatch <id> <action>
傳送動作至群組中的所有裝置。
可用動作: refresh、clear-cache、system-menu-open、system-menu-close、system-info-open、system-info-close、local-sync-panel-open、local-sync-panel-close、debug-panel-open、debug-panel-close、logging-on、logging-off、test-panel-open、test-panel-close
bricks group refresh <id>
重新整理群組中的所有裝置。
bricks group monitor <id>
即時監控群組中的所有裝置。
應用程式
bricks app new
在工作區中建立新應用程式。
bricks app list
列出所有應用程式。
bricks app get <id>
顯示應用程式詳細資訊。
bricks app update <id>
更新應用程式的中繼資料或設定。
bricks app check-config <path>
依 BRICKS 結構描述驗證設定檔。
bricks app bind <id>
將裝置綁定或解除綁定至應用程式。
bricks app short-edit <id>
不需完整發行即可套用快速屬性變更。
bricks app short-refs <id>
列出可用於快速編輯的參考。
bricks app trigger <id> <testId>
觸發應用程式上的自動化測試。
bricks app release <id>
發行應用程式的新版本。
bricks app project-pull <id>
從伺服器拉取應用程式原始程式碼檔案。
bricks app project-init <id>
從現有應用程式初始化 bricks-ctor。
已淘汰——請改用
bricks ctor init <id>。舊指令仍可使用,並會自動導向新指令。模組
bricks module new
在工作區中建立新模組。
bricks module list
列出所有模組。
bricks module get <id>
顯示模組詳細資訊。
bricks module update <id>
更新模組的中繼資料或設定。
bricks module short-edit <id>
不需完整發行即可套用快速屬性變更。
bricks module short-refs <id>
列出可用於快速編輯的參考。
bricks module release <id>
發行模組的新版本。
bricks module project-pull <id>
從伺服器拉取模組原始程式碼檔案。
bricks module project-init <id>
從現有模組初始化 bricks-ctor。
已淘汰——請改用
bricks ctor init <id> --type module。舊指令仍可使用,並會自動導向新指令。BRICKS 專案(bricks ctor)
從 CLI 建立、同步、編譯、部署並模擬 bricks-ctor 專案。
bricks ctor init <id>
從應用程式或模組初始化 BRICKS 專案。需要先登入驗證。取代已淘汰的 bricks app project-init 與 bricks module project-init。
bricks ctor postinstall
重新生成專案本機的 ctor/ 函式庫、MCP 設定與 skills。並移轉舊版 bricks-ctor 專案。
bricks ctor pull
以三方 Git 合併從 BRICKS 拉取最新的專案檔案。
bricks ctor push
編譯並推送設定,但不建立發行版本。
bricks ctor deploy
編譯專案並發行新版本。
bricks ctor compile
對專案設定進行型別檢查與編譯,然後加以驗證。
bricks ctor simulator
在本機 Simulator 視窗中執行專案。額外的旗標會傳遞給 Simulator,例如 --skip-typecheck、--clear-cache、--screenshot、--screenshot-delay、--screenshot-width、--screenshot-height 與 --screenshot-path。
bricks ctor mcp
以 STDIO 啟動專案的 bricks-ctor MCP 伺服器。
Media Flow
Media Flow 指令需要已啟用 Media Flow 的工作區。
bricks media boxes
列出所有 Media Flow 箱。
bricks media box <id>
顯示 Media Flow 箱的詳細資訊。
bricks media files <boxId>
列出 Media Flow 箱中的檔案。
bricks media file <id>
顯示檔案詳細資訊。
bricks media upload <boxId> <files...>
上傳一個或多個檔案至 Media Flow 箱。
Activity Log
Activity Log 指令會查詢 Activity Log,僅限 Business 方案的工作區使用。單次查詢的時間範圍上限為 30 天。
bricks al 作為 bricks activity-log 的簡短別名。
bricks activity-log events
查詢所有類型的 Activity Log 事件。
bricks activity-log screenshots
列出裝置的截圖時間戳記。
bricks activity-log screenshot
依指定時間戳記下載裝置的單張截圖。
BRICKS Buttress(bricks buttress)
將 BRICKS Buttress 伺服器與目前的工作區配對、檢視繫結狀態、核發長期 access token,並將 agent 連線至伺服器的本地函式。也可使用 bricks butr 作為簡寫。
bricks buttress bind
將本機的 Buttress 伺服器與目前 CLI profile 所屬的工作區配對,並寫入伺服器的 state.json。完成綁定後請重新啟動 Buttress 伺服器,變更才會生效。
bricks buttress unbind
從工作區移除繫結並刪除本機 state.json。
bricks buttress status
顯示本機 state.json 與工作區端的繫結伺服器清單。
bricks buttress issue-token
為非互動式呼叫端(CI 指令碼、CTOR 代理、ACP bridge)核發長期工作區 access token。
bricks buttress scan
透過 UDP 掃描區域網路上的 BRICKS Buttress 伺服器,並使用 HTTP /buttress/info 驗證每一台。會列出所有可達的伺服器(已繫結或未繫結),包含版本、認證狀態、所屬工作區,以及各 generator 的硬體能力。工作區與目前 CLI profile 相符的伺服器會被特別標示。
此指令不會核發 token。若需連線至已繫結伺服器,請於掃描後執行 bricks buttress issue-token。
bricks buttress mcp-config
輸出(或寫入)伺服器本地函式 MCP 端點的 .mcp.json 項目。未指定 --url 時會掃描區域網路,優先選擇有公告本地函式的伺服器,核發 workspace access token,並將該項目合併進 .mcp.json,不影響你其他的 MCP 伺服器設定。
探索流程不會為未回報你的工作區的伺服器核發 token — 未繫結或屬於其他工作區的主機都算不符,而且區域網路上任何機器都能回應探測封包。若要刻意指定這類伺服器,請使用
--url;未啟用驗證的伺服器則使用 --no-token。若既有的 .mcp.json 格式不正確,指令會回報錯誤而不會覆寫它。
自我更新
bricks update-cli
就地更新 CLI。藉由檢查 process.execPath 與 process.argv[1],自動偵測目前執行的 CLI 安裝方式(npm 全域、Bun 全域,或單一執行檔),然後執行對應的更新指令。當偵測不明確或主要方式失敗時,會改用 CDN 的二進位安裝程式(install.sh / install.ps1)。
設定
bricks config show
顯示目前的 CLI 設定。
bricks config endpoint [environment]
顯示或變更 API 端點。
環境: prod(https://display.bricks.tools)、beta(https://display-beta.bricks.tools)、dev(http://localhost:3001)
工作區
bricks workspace
顯示目前工作區的詳細資訊。也可以使用 bricks ws。
互動模式
bricks interactive
啟動終端機 UI,用於瀏覽和控制裝置、應用程式、模組及媒體。也可以使用 bricks i。
操作鍵:
DevTools
bricks devtools scan
掃描本機網路上的 BRICKS DevTools 伺服器。每個裝置都會回報其驗證狀態:workspace-jwt(工作區 token 驗證,當裝置已繫結至工作區時顯示)、passcode、locked 或 open(較舊版本)。
bricks devtools open <address>
顯示 DevTools 伺服器的相關資訊(名稱、版本、裝置 ID、工作區、協定、驗證)。回報的驗證狀態為 workspace-jwt(工作區 token 驗證,當裝置已繫結至工作區時顯示)、passcode、locked 或 open(較舊版本)其中之一。
bricks devtools issue-token
為目前的 profile 核發或重新整理工作區範圍的 DevTools access token,並儲存至 CLI 設定(~/.bricks-cli/config.json)。token 本身不會被列印——指令只會列印 profile、工作區、到期時間與 token id。
devtools 指令會自動取得並重新整理此 token,因此您鮮少需要手動執行
issue-token。DevTools CDP 指令
CDP 指令需要 BRICKS Foundation 2.24 或更新版本。所有 CDP 指令共用下列選項:
當裝置支援工作區驗證且您已登入其工作區時,指令會自動以快取的 token 進行驗證,並在收到
403 回應時重新核發。bricks devtools screenshot
透過 CDP 擷取裝置截圖並儲存至本機。
Brick 檢視(bricks devtools brick)
bricks devtools brick tree
列印 brick 元件樹。
bricks devtools brick query <selector>
以 CSS selector 查詢 brick 並顯示其屬性。
bricks devtools brick query-all <selector>
找出符合 CSS selector 的所有 brick。
bricks devtools brick attributes <nodeId>
以節點 ID 取得 brick 的全部屬性。
bricks devtools brick box-model <nodeId>
取得 brick 的尺寸與位置資訊(content、padding、border、margin)。
bricks devtools brick resolve <nodeId>
將 brick 解析為 JavaScript 物件並顯示其屬性。
bricks devtools brick focus <nodeId>
聚焦某個 brick 元素。
輸入模擬(bricks devtools input)
bricks devtools input tap <x> <y>
在指定座標點選。
bricks devtools input type <text>
將文字輸入目前聚焦的元素。
bricks devtools input key <key>
派送按鍵事件(例如 Enter、Escape、Tab)。
網路檢視(bricks devtools network)
bricks devtools network list
擷取網路活動的快照。
bricks devtools network get <requestId>
取得已擷取網路請求的回應內容。
儲存檢視(bricks devtools storage)
bricks devtools storage system persist
顯示持久化的系統儲存項目。
bricks devtools storage system memory
顯示記憶體中的系統儲存項目。
bricks devtools storage data-bank list
列出裝置上的所有 Data Bank。
bricks devtools storage data-bank get <name> <store>
從 Data Bank 的 store 查詢資料。
bricks devtools storage generator-cache
顯示 Generator 快取項目。
Runtime(bricks devtools runtime)
bricks devtools runtime eval <expression>
於裝置上執行 JavaScript 運算式。
bricks devtools runtime properties <objectId>
以物件 ID 取得遠端 JavaScript 物件的屬性。
Simulator(bricks devtools simulator)
檢視並匯出來自執行中 CTOR 或 Config Editor Simulator 的模擬熱感印表機輸出。列印記錄保存於記憶體中——每台印表機最多 10 筆列印,並於重新載入時清除。
bricks devtools simulator thermal-printer list
列出已擷取的熱感印表機列印。
bricks devtools simulator thermal-printer print-result -o <file>
將已擷取的熱感印表機列印匯出至檔案。
ACP 橋接
bricks desktop-acp-bridge
將 acpx 或其他 ACP 用戶端連線至正在執行的 CTOR 應用程式。橋接器在 ACP 用戶端與桌面應用程式的 Unix socket 之間傳遞 ACP JSON-RPC 訊息——預設使用 stdio,加上 --ws 則改為 WebSocket 伺服器。
在
--ws 模式下,每個 WebSocket 用戶端都會獲得自己專屬的 ACP Unix socket 連線;一個 WebSocket 文字訊框對應一筆 JSON-RPC 訊息。預設綁定主機為 0.0.0.0,因為 WebSocket 模式設計用於 LAN 暴露(例如其他機器上的瀏覽器或行動用戶端)——請務必設定 --auth-token 並僅於受信任網路上執行。若要限制為本機,請使用 --host 127.0.0.1。
桌面應用程式必須正在執行,並已在 Settings > Agent 中啟用 ACP。詳細設定請參閱 ACP 參考。