CLIリファレンス

ブラウザは作業の確認と編集に、agboardはエージェントの更新とプロジェクトの管理に使います。ほとんどのコマンドは、--project NAMEを明示します。例はMy projectを使っているので、自分のプロジェクト名に置き換え、CLIが返すタスクIDを使ってください。各オプションはagboard --helpかagboard <command> --helpで確認できます。

コマンドの一覧

したいこと	コマンド
タスクを追加する	add
タスクやボードを読む	show、ls、snapshot
タスクを移す、エージェントの状態を報告する	mv、state
進捗を記録する	history add
タスクの本文を編集する	edit
画像を添付する	attachment
タスクをまとめて順序づける	epic、progress
変更を待つ	wait
プロジェクトとフォルダを管理する	project、workspace
サーバーを起動し、エージェント連携を設定する	serve、stop、setup、hook
削除する（人だけ）	rm、project rm、epic rm、init

タスクを追加して確認する

タスクを追加して、ボードを確認します。

agboard --project "My project" add "Write the setup guide" --assignee ai --actor ai
agboard --project "My project" ls --json
agboard --project "My project" show 1 --json
agboard --project "My project" snapshot --json

--assigneeは担当を指します。--actorは変更を行う主体を指し、権限を決めます。人にはhuman、エージェントにはaiを使います。snapshotは、エピックとファイルの問題を含む、ボード全体と履歴を返します。

作業を報告する

作業の開始を報告します。

agboard --project "My project" mv 1 doing --actor ai --reason "Start implementation"
agboard --project "My project" state 1 running --actor ai --reason "Writing and checking the guide"

列の移動や、待機中以外への状態変更では、--reasonで理由を指定できます。指定は任意で、上限は10,000 Unicode文字です。理由を省略するか空白にすると、現在の状態から生成します。これらの操作は履歴を自動で追加するので、同じ操作の履歴を重複して追加しないでください。質問と回答の文には、2,000文字という別の上限があります。

列や状態を変えない、意味のある進捗を記録します。

agboard --project "My project" history add 1 --reason "Checked the installation links and recorded the result in the task body"
agboard --project "My project" history add 1 --reason-file progress.txt

コマンドが時刻を付け、AIの書き込み権限を適用します。actor・イベントID・種別・時刻の指定は要りません。意味のある進捗、判断、検証、中断、再開のときに、実際の作業と検証に基づく簡潔な理由を書きます。理由を省略するか空白にすると、状態に合った既定の文を生成します。AIは、下書き・アーカイブ済み・完了のタスクに履歴を追加できません。

タスクを終える

終えるには、TASK.mdに検証を記録し、検証した受入条件のdoneをtrueにします。サーバーが動いていれば、対象のAI担当タスクを自動で完了に移すので、mv ... done --actor aiは実行しません。規則はMarkdownファイルの形式を参照してください。完了したタスクはエージェントから読み取り専用で、作業が必要になったら、ユーザーが再開できます。

質問する

判断を求めるには、state ... pending --request-jsonを使います。回答まで待つのが既定です。質問を登録してすぐに戻るよう明示された場合だけ--no-waitを付けます。待機にはagboard serveが必要ですが、--no-waitには不要です。--no-waitと整数のwait.timeoutSecondsは併用できず、invalid_argument（終了コード2）で終わり、質問やタスクは変更されません。3つのコマンド例は判断依頼を参照してください。エピックと進行表はエピックと進行表を参照してください。

ファイルを使って本文を編集する

長いMarkdown本文は、ファイルに書いてから読み込ませると編集しやすくなります。

agboard --project "My project" edit 1 --desc-file task.md

説明は50,000文字まで、エピックの詳細（EPIC.md）は100,000文字まで使えます。ファイルはMarkdownファイルの形式に従う必要があります。標準入力から説明を読むには、--desc -を使います。

edit --desc-fileは、本文と受入条件を置き換え、TASK.mdの最新の履歴を保ちます。入力ファイルの履歴は無視されます。CLIや画面からの移動・状態の変更などの操作は、TASK.mdに履歴を追加し、show・snapshot・ブラウザは同じ履歴を読みます。

エピックの詳細を編集する

エピックの詳細は、frontmatterを含むEPIC.mdの全文です。文字列で直接渡すか、ファイルや標準入力から読み込みます。

agboard --project "My project" epic edit LAUNCH --document-file epic.md
agboard --project "My project" epic edit LAUNCH --document -
agboard --project "My project" epic edit LAUNCH --priority "3,1,2"

--documentと--document-fileは同時に指定できません。どちらも100,000文字まで受け付けます。以前の--planと--plan-fileは削除されました。新しい名前はデータとバックアップの移行の節を参照してください。

一覧を絞り込む

agboard --project "My project" ls --column doing --json
agboard --project "My project" ls --state pending --json
agboard ls --all-projects --json

ls --all-projectsは、全プロジェクトを名前順に読み、タスクの説明と履歴を完全な形で返します。--columnと--stateの絞り込みはすべてのプロジェクトに適用されます。--projectとは組み合わせません。

プロジェクト

agboard project create "My project"
agboard project ls --json
agboard --project "My project" project rename "Website launch"
agboard project bind "My project" --folder ./docs

名前を変えても、プロジェクトのID・フォルダの登録・タスクは保たれます。フォルダの登録とプロジェクトの削除は、データとバックアップに説明があります。

変更またはタスクを待つ

waitには二つのモードがあります。--after <cursor>はエージェントとの連携のとおりプロジェクトの変更を待ちます。--until taskは、リッスン開始前からTodoにあったタスクや、IdleのままDoingにあるタスクも含め、対象となるAI担当タスクを一件返します。

agboard --project "My project" wait --until task --idle-timeout 300 --json

--until taskには--idle-timeoutが必須です。1〜86,400秒を指定し、既定値はありません。一回の呼び出しで返すのは進行表と同じ順序の一件で、タスクを占有したり変更したりしません。取得したタスクを解決したら、再びwaitを呼び出します。セッション全体の流れとPendingの扱いはエージェントとの連携を参照してください。

取得成功時は、一つのJSONオブジェクトを出力して終了コード0を返します。

{"kind":"task","projectId":"<id>","cursor":"<cursor>","task":{"id":1},"taskPath":"…/tasks/1/TASK.md","documentPath":null}

指定した時間に対象タスクがなかった場合は、{"kind":"idle_timeout","projectId":"<id>","idleTimeoutSeconds":300}を出力して終了コード0を返します。これは対象なしでの正常終了であり、それまでの作業成功を示しません。board_unavailable・project_not_found・不正なボードデータ・引数誤りは、引き続き終了コード0以外のエラーです。--timeoutは--afterモードだけに指定でき、変更待ちが成立しなければエラーwait_timeoutになります。Pendingの質問への回答にはなりません。

サーバーを起動する

agboard serveは、127.0.0.1でボードを起動します。--portでポートを選べます（既定は7420）。サーバーの起動と同時にngrokでスマホを接続するには、--monitor ngrokを付けます。

オプション	意味
--monitor ngrok	モバイルモニターの接続を始めます。指定できるのはngrokだけです。環境変数NGROK_AUTHTOKENが必要で、トークンを引数で渡すことはできません。

スマホは、起動ごとに作る4桁の合言葉で守られます。サインイン用のオプションはありません。--monitorの不正な値、NGROK_AUTHTOKENがないこと、未知のオプションは、終了コード2で終了します。接続を開始できなければ、serveは起動せず終了コード1で終了します。

接続の準備ができると、起動行にスマホ用のアドレスと合言葉が表示されます: Serving at http://127.0.0.1:7420/; mobile monitor at https://… with passcode 4821。--jsonでは、起動時の行にボードのurlとmonitorが入ります（mode: "ngrok"と、ngrokのスマホ用url・passcode）。合言葉を出力するのはここと、ボードの接続ダイアログだけです。トークンとポリシーは出力しません。ボードの設定からも接続を設定できます。詳しくはモバイルモニターのガイドを参照してください。

バックグラウンドで実行する

agboard serve -d（または--daemon）は、サーバーをバックグラウンドで起動し、準備ができた時点で戻ります。ターミナルは空き、閉じてもサーバーは止まりません。表示されるのは通常の起動時と同じアドレス（--monitor ngrokではスマホのアドレスと合言葉も）に加えて、プロセスIDとログファイルです。--portと--monitorは通常どおり使えます。--jsonでは、起動時のオブジェクトにpidとlogも入ります。

agboard serve -d
agboard stop

agboard stopは、実行中のサーバーを終了し、終了したところで戻ります。serveでもserve -dでも起動したサーバーを止められます。サーバーが動いていなければ、その旨を表示して終了コード0で終わります。stopに--projectは指定できません。

バックグラウンドのサーバーは、出力をデータフォルダのserve.logに書きます。スマホの合言葉が入るため、このファイルは自分だけが読めます。serve -dのたびに作り直されます。すでにサーバーが動いている場合、serve -dは終了コード1（already_serving）で終わります。バックグラウンドのサーバーを起動できない場合（ポートが使用中など）も、理由を表示して終了コード1で終わります。再起動後に自動で立ち上がることはありません。

共有フォルダをセットアップする

agboard setupは、データフォルダとそのshared/フォルダを作り、エージェントがそこへ書けるよう、CodexとClaude Codeのユーザー設定にデータフォルダを加えます。プロジェクトは要らず、あなた自身が実行します。Hookやエージェントのスキルはインストールしません。

agboard setup --dry-run
agboard setup --agent claude --json

--agent codex|claude|allで更新する設定を選びます（既定はall）。--dry-runは何も変更せず、--jsonは機械可読の出力を表示します。Codexの設定がsandbox_mode = "workspace-write"でないときは、拒否して何も変更しません。変更内容と設定ファイルのバックアップはデータとバックアップを参照してください。

出力と確認

JSON形式の出力が必要なときは--jsonを付けます。helpのテキスト・エラー・JSONの値は、ブラウザの言語に関わらず、常に英語です。

タスク・エピック・プロジェクトの削除と、initによるプロジェクトの初期化には、端末での人の確認が必要です。エージェントは、人に頼まなければなりません。

次に読む

• エージェントとの連携: 各コマンドを使う場面と、作業全体の流れ。
• トラブルシューティング: エラーコードの意味。