Documentation Index
Fetch the complete documentation index at: https://docs.bricks.tools/llms.txt
Use this file to discover all available pages before exploring further.
ほとんどのコマンドは -j または --json でマシンが読み取れる JSON 形式で出力できます。
BRICKS Foundation 管理(bricks device)
bricks device list
ワークスペース内のすべてのデバイスを一覧表示します。
| オプション | 説明 |
|---|
-k, --keyword <text> | キーワードでデバイスをフィルタリング |
-j, --json | JSON で出力 |
bricks device get <id>
ハードウェア仕様を含む、デバイスの詳細情報を表示します。
| オプション | 説明 |
|---|
-j, --json | JSON で出力 |
bricks device bind <passcode>
パスコードを使用して新しいデバイスをワークスペースにバインドします。
| オプション | 説明 |
|---|
-n, --name <name> | デバイスの名前を設定 |
bricks device control <id> <type>
デバイスにコントロールイベントを送信します。
| オプション | 説明 |
|---|
-p, --payload <json> | イベントとともに送信する JSON ペイロード |
bricks device refresh <id>
デバイス上のアプリケーションを再読み込みします。
bricks device clear-cache <id>
デバイス上のキャッシュをクリアします。
bricks device screenshot <id>
スクリーンショットを撮影してローカルに保存します。
| オプション | 説明 |
|---|
-o, --output <path> | スクリーンショットの保存パス |
--no-take | 新たに撮影せず既存のスクリーンショットを取得 |
bricks device monitor
デバイスのステータスをリアルタイムで監視します。インタラクティブなターミナルが必要です。
| オプション | 説明 |
|---|
-g, --group <id> | 特定のグループのデバイスのみ監視 |
-i, --interval <seconds> | ポーリング間隔(デフォルト:60) |
BRICKS Foundation グループ(bricks group)
bricks group list
すべてのデバイスグループを一覧表示します。
| オプション | 説明 |
|---|
-j, --json | JSON で出力 |
bricks group get <id>
グループの詳細を表示します。
| オプション | 説明 |
|---|
-j, --json | JSON で出力 |
bricks group devices <id>
グループ内のデバイスをオンライン/オフラインステータスとともに一覧表示します。
| オプション | 説明 |
|---|
-j, --json | JSON で出力 |
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>
グループ内のすべてのデバイスをリアルタイムで監視します。
| オプション | 説明 |
|---|
-i, --interval <seconds> | ポーリング間隔 |
アプリケーション
bricks app new
ワークスペースに新しいアプリケーションを作成します。
| オプション | 説明 |
|---|
-n, --name <name> | アプリケーション名(必須) |
-d, --description <text> | アプリケーションの説明 |
--layout-width <px> | レイアウトの幅(ピクセル) |
--layout-height <px> | レイアウトの高さ(ピクセル) |
--example <key> | サンプルテンプレートから作成 |
--init | 作成後にローカルの bricks-ctor を初期化 |
-o, --output <dir> | プロジェクト初期化の出力ディレクトリ |
-y, --yes | 確認プロンプトをスキップ |
-j, --json | JSON で出力 |
bricks app list
すべてのアプリケーションを一覧表示します。
| オプション | 説明 |
|---|
-k, --keyword <text> | キーワードでフィルタリング |
-j, --json | JSON で出力 |
bricks app get <id>
アプリケーションの詳細を表示します。
| オプション | 説明 |
|---|
-c, --composed | 組み合わせた設定を含める |
-j, --json | JSON で出力 |
bricks app update <id>
アプリケーションのメタデータまたは設定を更新します。
| オプション | 説明 |
|---|
-n, --name <name> | 名前を更新 |
-d, --description <text> | 説明を更新 |
-c, --config <json> | インライン JSON で設定を指定 |
-f, --file <path> | ファイルから設定を指定 |
--validate | 適用前に設定を検証 |
bricks app check-config <path>
BRICKS スキーマに対して設定ファイルを検証します。
| オプション | 説明 |
|---|
-j, --json | JSON で出力 |
bricks app bind <id>
デバイスをアプリケーションにバインドまたはバインド解除します。
| オプション | 説明 |
|---|
-b, --bind <ids> | バインドするデバイス ID |
-u, --unbind <ids> | バインド解除するデバイス ID |
bricks app short-edit <id>
完全なリリースなしで素早いプロパティ変更を適用します。
| オプション | 説明 |
|---|
-l, --list <json> | 適用する編集のリスト(必須) |
bricks app short-refs <id>
クイック編集に使用できるリファレンスを一覧表示します。
| オプション | 説明 |
|---|
-k, --keyword <text> | キーワードでフィルタリング |
-t, --types <prefixes> | タイプのプレフィックスでフィルタリング |
-j, --json | JSON で出力 |
bricks app trigger <id> <testId>
アプリケーションの自動化テストをトリガーします。
| オプション | 説明 |
|---|
--play | テストを開始 |
--stop | テストを停止 |
--setup-at-launch | 起動時にセットアップ |
-g, --match-group <group> | 特定のデバイスグループを対象にする |
bricks app release <id>
アプリケーションの新しいバージョンをリリースします。
| オプション | 説明 |
|---|
-c, --config <path|json> | 設定ファイルまたは JSON(必須) |
--version <name> | バージョン名 |
--changelogs <text> | 変更ログのテキスト |
-j, --json | JSON で出力 |
bricks app project-pull <id>
サーバーからアプリケーションのソースファイルをプルします。
| オプション | 説明 |
|---|
-j, --json | JSON で出力 |
bricks app project-init <id>
既存のアプリケーションから bricks-ctor を初期化します。
| オプション | 説明 |
|---|
-o, --output <dir> | 出力ディレクトリ |
-y, --yes | プロンプトをスキップしてデフォルトを使用 |
--no-git | Git の初期化をスキップ |
--no-install | 依存関係のインストールをスキップ |
--no-github-actions | GitHub Actions ワークフローをスキップ |
--no-agents | AGENTS.md の生成をスキップ |
--no-claude | CLAUDE.md の生成をスキップ |
--gemini | GEMINI.md を含める(デフォルトはオフ) |
-j, --json | JSON で出力 |
モジュール
bricks module new
ワークスペースに新しいモジュールを作成します。
| オプション | 説明 |
|---|
-n, --name <name> | モジュール名(必須) |
-d, --description <text> | モジュールの説明 |
--layout-width <px> | レイアウトの幅(ピクセル) |
--layout-height <px> | レイアウトの高さ(ピクセル) |
--public | モジュールを公開する |
--allow-modify | 他のユーザーによるモジュールの変更を許可 |
--init | 作成後にローカルの bricks-ctor を初期化 |
-o, --output <dir> | プロジェクト初期化の出力ディレクトリ |
-y, --yes | 確認プロンプトをスキップ |
-j, --json | JSON で出力 |
bricks module list
すべてのモジュールを一覧表示します。
| オプション | 説明 |
|---|
-k, --keyword <text> | キーワードでフィルタリング |
-j, --json | JSON で出力 |
bricks module get <id>
モジュールの詳細を表示します。
| オプション | 説明 |
|---|
-j, --json | JSON で出力 |
bricks module update <id>
モジュールのメタデータまたは設定を更新します。
| オプション | 説明 |
|---|
-n, --name <name> | 名前を更新 |
-d, --description <text> | 説明を更新 |
-c, --config <json> | インライン JSON で設定を指定 |
-f, --file <path> | ファイルから設定を指定 |
--validate | 適用前に設定を検証 |
bricks module short-edit <id>
完全なリリースなしで素早いプロパティ変更を適用します。
| オプション | 説明 |
|---|
-l, --list <json> | 適用する編集のリスト(必須) |
bricks module short-refs <id>
クイック編集に使用できるリファレンスを一覧表示します。
| オプション | 説明 |
|---|
-k, --keyword <text> | キーワードでフィルタリング |
-t, --types <prefixes> | タイプのプレフィックスでフィルタリング |
-j, --json | JSON で出力 |
bricks module release <id>
モジュールの新しいバージョンをリリースします。
| オプション | 説明 |
|---|
-c, --config <path|json> | 設定ファイルまたは JSON(必須) |
--version <name> | バージョン名 |
--changelogs <text> | 変更ログのテキスト |
-j, --json | JSON で出力 |
bricks module project-pull <id>
サーバーからモジュールのソースファイルをプルします。
| オプション | 説明 |
|---|
-j, --json | JSON で出力 |
bricks module project-init <id>
既存のモジュールから bricks-ctor を初期化します。
| オプション | 説明 |
|---|
-o, --output <dir> | 出力ディレクトリ |
-y, --yes | プロンプトをスキップしてデフォルトを使用 |
--no-git | Git の初期化をスキップ |
--no-install | 依存関係のインストールをスキップ |
--no-github-actions | GitHub Actions ワークフローをスキップ |
--no-agents | AGENTS.md の生成をスキップ |
--no-claude | CLAUDE.md の生成をスキップ |
--gemini | GEMINI.md を含める(デフォルトはオフ) |
-j, --json | JSON で出力 |
Media Flow コマンドは Media Flow が有効なワークスペースが必要です。
すべての Media Flow ボックスを一覧表示します。
| オプション | 説明 |
|---|
-j, --json | JSON で出力 |
Media Flow ボックスの詳細を表示します。
| オプション | 説明 |
|---|
-j, --json | JSON で出力 |
Media Flow ボックス内のファイルを一覧表示します。
| オプション | 説明 |
|---|
-t, --types <types> | ファイルタイプでフィルタリング |
-u, --user-tag <tag> | ユーザータグでフィルタリング(繰り返し可) |
-l, --limit <n> | 結果数を制限 |
-o, --offset <n> | ページネーションのオフセット |
-j, --json | JSON で出力 |
ファイルの詳細を表示します。
| オプション | 説明 |
|---|
-j, --json | JSON で出力 |
1 つ以上のファイルを Media Flow ボックスにアップロードします。
| オプション | 説明 |
|---|
-d, --description <text> | ファイルの説明 |
-t, --user-tag <tag> | タグを追加(繰り返し可、最大 15 個) |
--image-version <spec> | 画像バージョンを生成(例:800x600:FILL)(繰り返し可) |
--image-version-type <format> | 画像バージョンの出力フォーマット |
--enable-ai-analysis | アップロードしたファイルに AI 分析を実行 |
--ai-instruction <text> | AI 分析のカスタム指示 |
--concurrency <n> | 並列アップロード数 |
-j, --json | JSON で出力 |
Activity Log
Activity Log コマンドは Activity Log に対してクエリを実行します。Business プランのワークスペースでのみ利用可能です。1 回のクエリで指定できる時間範囲は最大 30 日です。
このセクションのコマンドはすべて読み取り専用のクエリです。bricks activity-log の短縮エイリアスとして bricks al を使用できます。
bricks activity-log events
すべてのイベントタイプにわたって Activity Log のイベントをクエリします。
| オプション | 説明 |
|---|
--start-time <datetime> | 開始時刻。ISO 8601 または相対時間(例:1h、30m、2d)(必須) |
--end-time <datetime> | 終了時刻(デフォルト:現在時刻) |
--device <id> | デバイス ID でフィルタリング |
--type <type> | イベントタイプでフィルタリング:general、data、local_sync |
--event-name <name> | イベント名でフィルタリング |
--subspace <id> | Subspace ID でフィルタリング |
--sender <id> | sender でフィルタリング |
--limit <n> | 表示するイベント数の上限 |
-j, --json | JSON 配列で出力 |
--jsonl | JSONL としてストリーミング出力(1 行に 1 つの JSON オブジェクト) |
結果件数が多い場合は --jsonl の使用をおすすめします。イベントを受信次第 stdout にストリーミングするため、jq などのツールへのパイプに適しています。
bricks activity-log screenshots
デバイスのスクリーンショットのタイムスタンプ一覧を取得します。
| オプション | 説明 |
|---|
--device <id> | デバイス ID(必須) |
--start-time <datetime> | 開始時刻。ISO 8601 または相対時間(必須) |
--end-time <datetime> | 終了時刻(デフォルト:現在時刻) |
-j, --json | JSON で出力 |
bricks activity-log screenshot
指定したタイムスタンプの単一のスクリーンショット画像をデバイスからダウンロードします。
| オプション | 説明 |
|---|
--device <id> | デバイス ID(必須) |
--ts <timestamp> | スクリーンショットのタイムスタンプ。ISO 8601 または epoch ミリ秒(必須) |
--space <id> | ワークスペース ID(現在の profile から自動検出) |
-o, --output <path> | 出力ファイルパス(デフォルト:screenshot-<device>-<ts>.jpg) |
--open | ダウンロード後に OS 標準のビューアーで開く |
BRICKS Buttress(bricks buttress)
BRICKS Buttress サーバーを現在のワークスペースとペアリングし、バインディングを確認したり、長期間有効なアクセストークンを発行したりします。bricks butr というエイリアスも利用できます。
bricks buttress bind
ローカルの Buttress サーバーをアクティブな CLI プロファイルのワークスペースとペアリングし、サーバーの state.json を書き込みます。バインド後は変更を反映するために Buttress サーバーを再起動してください。
| オプション | 説明 |
|---|
-s, --server-id <id> | 自動検出されたサーバー ID を上書き(デフォルトは buttress-<machineId>) |
-n, --name <name> | ワークスペースのレコードに保存される表示名 |
--state-dir <dir> | Buttress state ディレクトリを上書き(デフォルトは ~/.bricks-cli/buttress) |
--print | ファイルに書き込まずに state.json を stdout に出力(リモートセットアップ向け) |
bricks buttress unbind
ワークスペースからバインディングを削除し、ローカルの state.json を削除します。
| オプション | 説明 |
|---|
-s, --server-id <id> | バインドを解除するサーバー ID(デフォルトはローカルマシンの ID) |
--state-dir <dir> | Buttress state ディレクトリを上書き |
--keep-local | ローカルの state.json ファイルを削除しない |
bricks buttress status
ローカルの state.json とワークスペース側のバインド済みサーバー一覧を表示します。
| オプション | 説明 |
|---|
--state-dir <dir> | Buttress state ディレクトリを上書き |
-j, --json | { "local": …, "remote": [...] } の JSON で出力 |
bricks buttress issue-token
ヘッドレス呼び出し元(CI スクリプト、CTOR エージェント、ACP ブリッジ)向けに長期間有効なワークスペースアクセストークンを発行します。
| オプション | 説明 |
|---|
--ttl <seconds> | 有効期間(秒)。デフォルトは 30 日 |
-j, --json | JSON で出力:{ token, expiresAt, workspaceId, jti } |
トークンは Authorization: Bearer <token> ヘッダー、または WebSocket URL の ?access_token=<token> クエリ文字列として送信します。
bricks buttress scan
LAN 上の BRICKS Buttress サーバーを UDP でスキャンし、HTTP /buttress/info で各サーバーを検証します。バインド済みか否かを問わず、到達可能なすべてのサーバーをバージョン、認証状態、バインドされているワークスペース、generator ごとのハードウェア能力とともに一覧表示します。アクティブな CLI プロファイルとワークスペースが一致するサーバーはハイライトされます。
このコマンドはトークンを発行しません。バインド済みサーバーに接続する必要がある場合は、スキャン後に bricks buttress issue-token を実行してください。
| オプション | 説明 |
|---|
-t, --timeout <ms> | スキャンのタイムアウト(ミリ秒、デフォルト:3000) |
-p, --port <port> | UDP 検出ポート(デフォルト:8089) |
--udp-only | HTTP /buttress/info 検証ステップをスキップ |
-j, --json | JSON で出力:{ servers, workspaceId } |
セルフアップデート
bricks update-cli
CLI をその場で更新します。process.execPath と process.argv[1] を調べて、実行中の CLI のインストール方法(npm グローバル、Bun グローバル、スタンドアロンバイナリ)を自動検出し、対応する更新コマンドを実行します。検出が不確実な場合や主な方法が失敗した場合は、CDN のバイナリインストーラー(install.sh / install.ps1)にフォールバックします。
| オプション | 説明 |
|---|
-y, --yes | 確認プロンプトをスキップ(非対話シェルでは必須) |
--channel <channel> | チャネルを上書き:release または beta |
bricks update-cli # 更新前に確認
bricks update-cli -y # 非対話、CI やスクリプト用
bricks update-cli --channel beta # beta チャネルを強制
バイナリ名が bricks-beta の場合、または実行中のバージョンにプレリリース接尾辞が含まれる場合、チャネルは beta がデフォルトになります。それ以外の場合は release がデフォルトです。
bricks config show
現在の CLI 設定を表示します。
| オプション | 説明 |
|---|
-j, --json | JSON で出力 |
bricks config endpoint [environment]
API エンドポイントを表示または変更します。
環境: prod(https://display.bricks.tools)、beta(https://display-beta.bricks.tools)、dev(http://localhost:3001)
ワークスペース
bricks workspace
現在のワークスペースの詳細を表示します。bricks ws でも利用できます。
| オプション | 説明 |
|---|
-j, --json | JSON で出力 |
インタラクティブモード
bricks interactive
デバイス、アプリケーション、モジュール、メディアを閲覧・操作するためのターミナル UI を起動します。bricks i でも利用できます。
操作キー:
| キー | 動作 |
|---|
↑ / ↓ または j / k | ナビゲート |
Enter | 選択 |
Esc | 戻る |
q | 終了 |
ローカルネットワーク上の BRICKS DevTools サーバーをスキャンします。
| オプション | 説明 |
|---|
-t, --timeout <ms> | スキャンのタイムアウト(ミリ秒) |
-j, --json | JSON で出力 |
--verify | HTTP で各サーバーを確認 |
--udp-only | UDP ブロードキャストのみ使用 |
-p, --port <port> | カスタムポート |
デバイスの詳細設定で Enable LAN Discovery が有効になっている必要があります(デフォルトで有効)。
DevTools サーバーの情報(名前、バージョン、デバイス ID、ワークスペース、プロトコル、認証)を表示します。
| オプション | 説明 |
|---|
-p, --port <port> | カスタムポート |
--info | 接続 URL(Web UI、CDP、MCP、MCP SSE、Info エンドポイント)と認可情報を表示 |
CDP コマンドには BRICKS Foundation バージョン 2.24 以降が必要です。すべての CDP コマンドは以下のオプションを共有します:| オプション | 説明 |
|---|
-a, --address <address> | DevTools サーバーのアドレス(必須) |
-p, --port <port> | サーバーポート(デフォルト: 19851) |
--passcode <passcode> | デバイスのパスコード |
-j, --json | JSON 形式で出力 |
CDP 経由でデバイスのスクリーンショットを取得し、ローカルに保存します。
| オプション | 説明 |
|---|
-o, --output <path> | 出力ファイルパス(デフォルト: screenshot-<timestamp>.png) |
brick コンポーネントツリーを出力します。
| オプション | 説明 |
|---|
-d, --depth <depth> | 最大深度、-1 で完全なツリー(デフォルト: 3) |
CSS セレクターで brick を検索し、その属性を表示します。
CSS セレクターに一致するすべての brick を検索します。
ノード ID で brick のすべての属性を取得します。
brick の寸法と位置(content、padding、border、margin)を取得します。
brick を JavaScript オブジェクトに解決し、そのプロパティを表示します。
brick 要素にフォーカスします。
指定された座標でタップ/クリックします。
bricks devtools input type <text>
現在フォーカスされている要素にテキストを入力します。
キーイベントをディスパッチします(例: Enter、Escape、Tab)。
ネットワークアクティビティのスナップショットをキャプチャします。
| オプション | 説明 |
|---|
--duration <ms> | キャプチャ時間(ミリ秒、デフォルト: 2000) |
キャプチャされたネットワークリクエストのレスポンスボディを取得します。
永続化されたシステムストレージエントリを表示します。
メモリ内のシステムストレージエントリを表示します。
デバイス上のすべての Data Bank を一覧表示します。
Data Bank のストアからデータをクエリします。
| オプション | 説明 |
|---|
-l, --limit <count> | 取得する最大アイテム数(デフォルト: 25) |
-s, --skip <count> | スキップするアイテム数(デフォルト: 0) |
Generator キャッシュエントリを表示します。
デバイス上で JavaScript 式を評価します。
| オプション | 説明 |
|---|
--await | promise の結果を待機 |
オブジェクト ID でリモート JavaScript オブジェクトのプロパティを取得します。
ACP ブリッジ
bricks desktop-acp-bridge
acpx や他の ACP クライアントを実行中の CTOR アプリに接続します。ブリッジは ACP クライアントとデスクトップアプリの Unix ソケットの間で ACP JSON-RPC メッセージをパイプします — デフォルトでは stdio、--ws を付けると WebSocket サーバーとして動作します。
# Stdio モード(デフォルト) — acpx などの stdio ACP クライアント向け
acpx --agent 'bricks desktop-acp-bridge' "summarize this project"
# WebSocket モード — Unix ソケットを WebSocket サーバーとして公開
bricks desktop-acp-bridge --ws --auth-token <secret>
| オプション | 説明 |
|---|
--ws | stdio の代わりに Unix ソケットをブリッジする WebSocket サーバーを起動 |
--host <host> | WebSocket のバインドホスト(デフォルト: 0.0.0.0) |
--port <port> | WebSocket のポート(デフォルト: 8765) |
--auth-token <token> | WebSocket の Authorization ヘッダーにこの Bearer トークンを要求。BRICKS_DESKTOP_ACP_BRIDGE_TOKEN 環境変数でも設定可能 |
--ws モードでは、各 WebSocket クライアントが ACP Unix ソケットへの専用接続を持ちます。WebSocket テキストフレーム 1 つが JSON-RPC メッセージ 1 つに対応します。デフォルトのバインドホストが 0.0.0.0 なのは、WebSocket モードが LAN への公開(他のマシンのブラウザやモバイルクライアントなど)を想定しているためです — 必ず --auth-token を設定し、信頼できるネットワーク上でのみ実行してください。ローカルホストに制限するには --host 127.0.0.1 を使用します。
デスクトップアプリが起動しており、Settings > Agent で ACP が有効になっている必要があります。セットアップの詳細は ACP リファレンス をご覧ください。
MCP サーバー
bricks mcp start
AI エージェント連携のために BRICKS MCP サーバーを STDIO モードで起動します。
| オプション | 説明 |
|---|
-t, --token <token> | 認証トークンを上書き |
デバイスの MCP をローカル CLI にブリッジする
mcporter を使用して、デバイスの MCP エンドポイントをローカルの STDIO サーバーとしてブリッジします:
npx mcporter --url http://<device-ip>:19851/mcp --header "Authorization: Bearer <passcode>"