CLI commands

ワークボード CLI

openclaw workboard は、同梱の Workboard plugin 用ターミナルインターフェースです。オペレーターはカードの一覧表示、カードの作成、1件のカードの確認、および実行中の Gateway に対する準備済み作業のサブエージェントワーカー実行へのディスパッチ要求を行えます。

コマンドを使用する前に Plugin を有効にします。

bash
openclaw plugins enable workboardopenclaw gateway restart

使用方法

bash
openclaw workboard list [--board <id>] [--status <status>] [--include-archived] [--json]openclaw workboard create <title...> [--notes <text>] [--status <status>] [--priority <priority>] [--agent <id>] [--board <id>] [--labels <items>] [--json]openclaw workboard show <id> [--json]openclaw workboard move <id> --status <status> [--json]openclaw workboard dispatch [--board <id>] [--max-starts <count>] [--admin] [--url <url>] [--token <token>] [--timeout <ms>] [--json]

このコマンドは、ダッシュボードおよび Workboard エージェントツールが使用するものと同じ、Plugin が所有する SQLite データベースを読み書きします。カード ID は UUID です。カード ID を受け付けるコマンドでは、一意に特定できる ID プレフィックスも使用できます(簡潔なテキスト出力には先頭の 8 文字が表示されます)。

有効な status 値: triagebacklogtodoscheduledreadyrunningreviewblockeddone。有効な priority 値: lownormalhighurgent

list

bash
openclaw workboard listopenclaw workboard list --board default --status readyopenclaw workboard list --json

テキスト出力は簡潔です。

text
7f4a2c10  ready     high    default agent-a  古いワーカーの Heartbeat を修正

列は、ID プレフィックス、ステータス、優先度、ボード ID、任意のエージェント ID、およびタイトルです。

フラグ 目的
--board <id> 結果を 1 つのボード名前空間に限定する
--status <status> 結果を 1 つの Workboard ステータスに限定する
--include-archived 簡潔なテキスト出力にアーカイブ済みカードを含める
--json カード一覧全体をマシン用 JSON として出力する

CLI を /workboard list と一致させるため、簡潔なテキスト出力ではデフォルトでアーカイブ済みカードが非表示になります。表示するには --include-archived を渡します。既存の自動化との互換性を保つため、JSON 出力にはアーカイブ済みカードを含むカード一覧全体が常に保持されます。

create

bash
openclaw workboard create "Fix stale worker heartbeat" --priority high --labels bug,workboardopenclaw workboard create "Write Workboard docs" --status ready --agent docs-agent --board docs --notes "Cover CLI, slash command, dispatch, and SQLite state."
フラグ 目的
--notes <text> カードの初期メモ
--status <status> 初期ステータス。デフォルトは todo
--priority <priority> 優先度。デフォルトは normal
--agent <id> カードをエージェントまたは所有者 ID に割り当てる
--board <id> カードをボード名前空間に保存する
--labels <items> カンマ区切りのラベル
--json 作成したカードをマシン用 JSON として出力する

create は Workboard の SQLite 状態に直接書き込みます。カードは Control UI の Workboard タブおよび Workboard ツールに即座に表示されます。

show

bash
openclaw workboard show 7f4a2c10openclaw workboard show 7f4a2c10 --json

テキスト出力には、簡潔なカード行とメモが表示されます。JSON 出力は、実行メタデータ、試行、コメント、リンク、証明、成果物、ワーカーログ、プロトコル状態、診断、および自動化メタデータを含むカードレコード全体を返します。

move

bash
openclaw workboard move 7f4a2c10 --status reviewopenclaw workboard move 7f4a2c10 --status done --json

move は、ダッシュボードでカードをドラッグする場合と同じ手動オペレーター経路を使用して、カードのステータスを変更します。完全なカード ID または一意に特定できるプレフィックスを受け付けます。アクティブな依存関係およびスケジュールによる保留は引き続き適用されます。オペレーターは、エージェントのクレームトークンがなくてもクレーム済みカードを移動できます。クレームトークンの適用範囲は引き続きエージェントツールによる変更に限定され、JSON 出力では編集されます。

dispatch

bash
openclaw workboard dispatchopenclaw workboard dispatch --jsonopenclaw workboard dispatch --max-starts 10openclaw workboard dispatch --adminopenclaw workboard dispatch --url http://127.0.0.1:18789 --token "$OPENCLAW_GATEWAY_TOKEN"

dispatch は、まず実行中の Gateway RPC メソッド workboard.cards.dispatch を呼び出します。このメソッドはダッシュボードのディスパッチ操作と同じサブエージェントランタイムを使用するため、準備済みカードはリンクされたセッションキーを持つタスク追跡対象のワーカー実行になります。--max-starts は追加的な workboard.cards.dispatchWithOptions メソッドを使用するため、古い Gateway はワーカーを開始する前にこのオプションを拒否します。このフラグを使用する前に、アップグレード後の Gateway を再起動してください。エージェントが割り当てられたカードでは、エージェントスコープのサブエージェントセッションキーが使用されます。未割り当てのカードでは、Gateway に設定されたデフォルトエージェントを維持するため、スコープなしのサブエージェントキーが保持されます。

ディスパッチループは次を行います。

  1. 依存関係が準備済みの子を ready に昇格します。
  2. 期限切れのクレームまたはタイムアウトしたワーカー実行をブロックします。
  3. 準備済みカードにディスパッチメタデータを記録します。
  4. クレームされていない準備済みカードから少数のバッチを選択します。
  5. 選択した各カードをディスパッチャーまたは割り当て済みエージェント用にクレームします。
  6. 範囲を制限したカードコンテキストとカードのクレームトークンを使用して、サブエージェントワーカー実行を開始します。
  7. ワーカー実行 ID、セッションキー、Gateway タスク台帳から報告された場合のタスクリンク、実行ステータス、およびワーカーログをカードに保存します。

選択は慎重に行われます。1 回のディスパッチで開始するワーカーはデフォルトで最大 3 件です。アーカイブ済みまたはクレーム済みのカードはスキップされ、1 回の処理で所有者またはエージェントごとに 1 件のカードのみが開始されます。アクティブな実行中またはレビュー中の作業をすでに所有しているカードは、後続のディスパッチまで保留されます。処理ごとの上限を変更するには、正の整数を指定して --max-starts <count> を渡します。所有者ごとに 1 件という規則は引き続き適用されるため、実際の開始数は少なくなる場合があります。

カードのクレーム後にワーカーの開始に失敗した場合、Workboard はそのカードをブロックし、クレームを解除して、カードの実行メタデータとワーカーログメタデータに失敗を記録します。失敗した開始を暗黙的にキューへ戻すのではなく、確認可能な状態に保ちます。

明示的な Gateway ターゲットが指定されておらず、ローカル Gateway が利用できないか、まだ Workboard ディスパッチメソッドを公開していない場合、CLI はローカルの Workboard 状態に対するデータのみのディスパッチへフォールバックします。データのみのディスパッチでも、依存関係の昇格、古いクレームのクリーンアップ、タイムアウトした実行のブロックは行えますが、ワーカーは開始されません。認証、権限、検証の失敗、および明示的な --url または --token ターゲットでの失敗は、フォールバックを発生させず直接報告されます。

テキスト出力にはワーカーの開始数が報告されます。

text
ディスパッチ完了: 開始=2 失敗=0

フォールバック出力は明示的です。

text
Gateway を利用できません。データのみをディスパッチしました: 昇格=1 ブロック=0

JSON 出力にはディスパッチ結果が含まれます。Gateway を利用するディスパッチには startedstartFailures が含まれる場合があります。データのみのフォールバックには gatewayUnavailable: true が含まれます。クレームトークンはカードの JSON 出力では編集されます。

ダッシュボードでは、同じディスパッチ結果が短い概要として表示されるため、オペレーターはカードの詳細を開かなくても、開始、昇格、ブロック、再クレーム、または失敗したカードの件数を確認できます。

スラッシュコマンドとの同等性

コマンド対応チャネルでは、対応するスラッシュコマンドを使用できます。

text
/workboard list/workboard show 7f4a2c10/workboard create 古いワーカーの Heartbeat を修正/workboard move 7f4a2c10 --status review/workboard dispatch

スラッシュコマンドのディスパッチも Gateway のサブエージェントランタイムを使用するため、ダッシュボードおよび CLI の Gateway 経路と同じクレーム、ワーカー開始、失敗時の動作に従います。

/workboard list/workboard show は、認可されたコマンド送信者向けの読み取りコマンドです。/workboard create/workboard move/workboard dispatch はボード状態を変更するため、チャットインターフェースでは所有者ステータスが必要です。または、operator.writeoperator.admin を持つ Gateway クライアントが必要です。

権限

CLI のディスパッチ経路は通常、Gateway の operator.write および operator.read スコープを要求します。ワークスペースに関連付けられたカードは、設定された特定のエージェントワークスペース内で直接実行されます。ワークツリー要求は、ホストによるリポジトリ管理コードの展開を許可せず、そのディレクトリに限定されます。選択されたワーカーには、その特定のワークスペースへの書き込み可能かつ非共有の Docker サンドボックスアクセス、要求されたマウントおよびポリシーと一致する稼働中のコンテナハッシュが必要であり、ホストから脱出する機能があってはなりません。operator.admin を明示的に要求し、別のホストチェックアウトを許可して、通常の管理対象ワークツリー設定を使用するには、--admin を渡します。そのスコープがクライアントに対して承認されていない場合、接続は失敗します。読み取り専用の Gateway トークンは、読み取りメソッドを通じて Workboard データを確認できますが、カードの作成やワーカーのディスパッチはできません。Workboard の変更権限を持つ呼び出し元による手動のカード移動は、それ以外ではワークスペース制限の影響を受けません。

ローカルの listcreateshowmove コマンドは、現在のプロファイルで使用されるローカル OpenClaw 状態ディレクトリを操作します。別の状態ルートが必要な場合は、最上位の openclaw コマンドで --dev または --profile <name> を使用します。

トラブルシューティング

カードが表示されない

同じプロファイルおよび状態ルートで Plugin が有効になっていることを確認します。

bash
openclaw plugins inspect workboard --runtime --json

ダッシュボードにはカードが表示されるのに CLI には表示されない場合は、両方のコマンドが同じ --dev または --profile 設定を使用していることを確認します。

ディスパッチがデータのみと表示される

Gateway を起動または再起動します。

bash
openclaw gateway restartopenclaw gateway status --deep

その後、openclaw workboard dispatch を再試行します。データのみのフォールバックはローカル状態のクリーンアップには役立ちますが、ワーカー実行には稼働中の Gateway が必要です。

ディスパッチで何も開始されない

アクティブなクレームがない ready カードが少なくとも 1 件あることを確認します。

bash
openclaw workboard list --status ready

同じ所有者に実行中またはレビュー中の作業がすでにある場合も、カードがスキップされることがあります。完了した作業を done に移動するか、Workboard ツールで古いクレームを解除するか、アクティブなワーカーの終了後にディスパッチを再実行します。

関連項目

Was this useful?
On this page

On this page