ターミナルからOrchestorのデータを確認し、繰り返し行う取得をスクリプトに組み込みます。コマンドの出力と診断情報を分けて扱えるため、手元での調査から、他のコマンドと組み合わせた処理へ進められます。
- ターミナルからブランドやレポートを取得
- JSONなどの形式で後続処理に接続
- 終了コードで失敗の種類を判別
利用環境と認証を確認する
インストール済みのバージョンとヘルプを確認してから利用します。CLIのコマンド名は orc（orchestor）です。
orc --version
orc --help
orc auth login
利用できるサブコマンドやオプションは、手元のバージョンのヘルプで確認します。認証が済んだら、対象ワークスペースを指定して読み取りを試します。
データを取得して後続処理へ渡す
次は、対象ワークスペースのブランド一覧をJSONで取得する例です。
orc brands list --workspace "$ORCHESTOR_WORKSPACE_ID" --json
標準出力にはデータ、標準エラー出力には診断情報が出ます。スクリプトでは両者を区別し、取得に失敗した診断文をデータとして取り込まないようにします。
出力形式にはJSONやCSVがあります。各コマンドが対応する形式と項目を確認してから、レポートや変換処理へ接続します。
終了コードを処理に使う
| コード | 結果 |
|---|---|
| 0 | 成功 |
| 1 | API・外部サービスのエラー |
| 2 | 認証エラー |
| 3 | 入力の検証エラー |
| 4 | ネットワークエラー |
| 5 | 内部エラー |
出力の有無だけで成功と判断せず、終了コードを確認します。認証や入力の誤りを修正する処理と、一時的な通信失敗への対応は分けて考えます。
繰り返しの作業へ広げる
まず一回のコマンドで、対象ワークスペースと出力の内容を確認します。次に、必要な項目だけを抽出し、後続処理へ渡します。定期実行する場合は、失敗時に気づける記録と通知を利用環境側で用意します。
画面で確認した値と比較するときは、対象・期間・条件を揃えてください。HTTPから直接組み込む場合はAPI、AIクライアントから対話的に操作する場合はMCPも利用できます。