​

Orchestor CLI

Orchestor CLI を使うと、ターミナル、CI/CD パイプライン、AI エージェントからブランド、プロンプト、AI の回答、レポートを操作できます。スクリプトには JSON、データ分析には CSV で結果を取得できます。

このリファレンスは CLI 0.5.0 リリース向けのコマンドと使い方に対応しています。CLI は orc で起動します。

登録、ワークスペース作成、初回観測は別の操作です。新しい対象を試すたびにアカウントを作り直す必要はありません。

macOS / Linux では、次のコマンドでインストールします。Node.js は不要です。

Windows・Alpine Linux・その他のインストール方法。

クイックスタートで認証とワークスペースを設定する。

macOS / Linux のインストーラーで導入したCLIは、次のコマンドで更新できます。

リリースノート。

--version でインストール済みのバージョンを表示します。

バージョンを確認し、対応するコマンドリファレンスを使用します。

対話操作では orc auth login でログインします。CI/CD やエージェントの実行環境では、シークレット管理機能から ORCHESTOR_API_KEY を設定します。この環境変数は保存済みの CLI 認証情報より優先されます。

実行環境の ORCHESTOR_WORKSPACE_ID に対象のワークスペース ID を設定し、--workspace に渡します。プログラムが結果を読む場合は JSON を指定します。

標準出力からデータを読み取り、診断情報の標準エラー出力と分けて扱います。

エラーメッセージの文字列ではなく終了コードで分岐します。0 は成功、1 は API または外部サービスのエラー、2 は認証・認可エラー、3 は検証エラー、4 はネットワークエラー、5 は内部エラーです。

出力やリクエストの設定はグローバルオプション、エージェント用スキルと MCP の設定はsetupを参照してください。

orc --help でインストール済みのコマンド一覧を確認できます。各コマンドに --help を付けると引数とフラグを表示します。0.5.0 ではデータ操作に複数形の名前空間を使い、ローカル設定も公開された名前空間から実行します。

以下の例は認証とワークスペースの選択が済んでいることを前提とします。YOUR_*_ID と YOUR_PROJECT_KEY は対応する一覧コマンドで取得した値に置き換えてください。

ブラウザでログインし、API から現在の認証情報を確認します。

auth の詳細を参照してください。

ログイン中のアカウントと利用状態を確認します。

whoami / status の詳細を参照してください。

標準入力から API キーを受け取り、CLI を初期化します。

init の詳細を参照してください。

ローカルの CLI 設定を表示し、設定値を確認・変更します。

config の詳細を参照してください。

CLI の認証元やローカルの設定状態を確認します。

status の詳細を参照してください。

同梱のスキルをエージェントへ導入します。MCPの接続にはエージェント接続の手順を使います。

setup の詳細を参照してください。

指定したシェル用の補完スクリプトを出力します。

completion の詳細を参照してください。

CLI の更新コマンドを実行します。更新方法とオプションは詳細リファレンスで確認できます。

update の詳細を参照してください。

利用できるワークスペースを一覧表示し、以降のコマンドで使う対象を選択します。

workspace の詳細を参照してください。

指定したワークスペースのメンバーを一覧表示します。

workspace-member の詳細を参照してください。

プロジェクトを一覧表示し、プロジェクトキーから詳細を取得します。

project の詳細を参照してください。

分析対象のブランドを一覧表示し、ブランド ID から詳細を取得します。

brand の詳細を参照してください。

製品の一覧とサマリーを取得します。

product の詳細を参照してください。

ワークスペースのドメインを一覧表示します。

domain の詳細を参照してください。

分析に使用するペルソナを一覧表示します。

persona の詳細を参照してください。

AI に送信するプロンプトを一覧表示し、詳細を取得します。

prompt の詳細を参照してください。

分析対象のトピックを一覧表示し、詳細を取得します。

topic の詳細を参照してください。

プロンプトの整理に使用するタグを一覧表示します。

tag の詳細を参照してください。

収集した AI の回答を一覧表示し、回答 ID から詳細を取得します。

answer の詳細を参照してください。

AI の回答で参照されるドメインと URL を一覧表示します。

source の詳細を参照してください。

AI の回答に関連するファンアウト検索クエリを一覧表示します。

fanout-query の詳細を参照してください。

ドメインに対する AI クローラーの robots.txt アクセスポリシーを確認します。

analytics の詳細を参照してください。

ワークスペースの Issue を一覧表示し、詳細を取得します。

issue の詳細を参照してください。

可視性、引用、センチメントなどのレポートを取得します。orc report はダイジェスト用のコマンドです。

report の詳細を参照してください。

開始日時を指定して API の使用量を取得します。

usage の詳細を参照してください。

開始日時を指定してコストの内訳を取得します。

cost の詳細を参照してください。