--- title: Orchestor CLI description: Orchestor CLI のインストール、認証、自動化と各コマンドの使い方を紹介します。 canonical_url: https://orchestor.io/docs/cli markdown_url: https://orchestor.io/docs/cli.md contentType: reference --- # Orchestor CLI Orchestor CLI を使うと、ターミナル、CI/CD パイプライン、AI エージェントから[ブランド](https://orchestor.io/docs/cli/brand.md)、[プロンプト](https://orchestor.io/docs/cli/prompt.md)、[AI の回答](https://orchestor.io/docs/cli/answer.md)、[レポート](https://orchestor.io/docs/cli/report.md)を操作できます。スクリプトには JSON、データ分析には CSV で結果を取得できます。 このリファレンスはリポジトリの現在のCLI実装を説明します。CLI は `orc` または `orchestor` で起動します。公開済みパッケージに含まれる機能は、インストールしたバージョンの `--help` で確認してください。 [Search Console CLI](https://orchestor.io/docs/cli/search-console.md)では、検索パフォーマンス、URL のインデックス状態、サイトマップを取得する開発中のコマンドを確認できます。 [Sheets CLI](https://orchestor.io/docs/cli/sheets.md)では、Google スプレッドシートの構造・値・ネイティブテーブルをエージェントから読み書きするコマンドを確認できます。 [Slides CLI](https://orchestor.io/docs/cli/slides.md)では、`--target` で接続を選び、プレゼンテーションの取得・作成と Slides API の呼び出しを行えます。 ## 始めたいことから選ぶ | 目的 | 手順 | | --- | --- | | Orchestorを初めて使う | [アカウント作成・メール認証・招待](https://orchestor.io/signup) | | 既存アカウントで端末を認証する | [CLIにサインイン](https://orchestor.io/docs/cli/quickstart.md) | | 同じアカウントで別の対象を始める | [新しいワークスペースを作成](https://orchestor.io/docs/cli/workflows/new-workspace.md) | | ブランドを設定して最初の結果を得る | [初回観測を実行](https://orchestor.io/docs/cli/workflows/onboarding.md) | | CodexやClaude Codeから操作する | [エージェントを接続](https://orchestor.io/docs/cli/workflows/agent-connect.md) | | CIから繰り返し実行する | [APIキーとCIの権限を設定](https://orchestor.io/docs/cli/workflows/ci-setup.md) | 登録、ワークスペース作成、初回観測は別の操作です。新しい対象を試すたびにアカウントを作り直す必要はありません。 ## Orchestor CLI をインストールする macOS / Linux では、次のコマンドでインストールします。Node.js は不要です。 ```sh curl -fsSL https://orchestor.io/install | sh ``` [Windows・Alpine Linux・その他のインストール方法](https://orchestor.io/docs/cli/installation.md)。 [クイックスタートで認証とワークスペースを設定する](https://orchestor.io/docs/cli/quickstart.md)。 ## Orchestor CLI を更新する macOS / Linux のインストーラーで導入したCLIは、次のコマンドで更新できます。 ```sh orc update ``` [リリースノート](https://orchestor.io/docs/cli/release-notes.md)。 ## バージョンを確認する `--version` でインストール済みのバージョンを表示します。 ```bash orc --version ``` *バージョンを確認し、対応するコマンドリファレンスを使用します。* ## CI/CD と AI エージェントで使用する 対話操作では `orc auth login` でログインします。CI/CD やエージェントの実行環境では、シークレット管理機能から `ORCHESTOR_API_KEY` を設定します。この環境変数は保存済みの CLI 認証情報より優先されます。 実行環境の `ORCHESTOR_WORKSPACE_ID` に対象のワークスペース ID を設定し、`--workspace` に渡します。プログラムが結果を読む場合は JSON を指定します。 ```bash orc brands list --workspace "$ORCHESTOR_WORKSPACE_ID" --json orc reports visibility get --workspace "$ORCHESTOR_WORKSPACE_ID" --json ``` *標準出力からデータを読み取り、診断情報の標準エラー出力と分けて扱います。* エラーメッセージの文字列ではなく終了コードで分岐します。`0` は成功、`1` は API または外部サービスのエラー、`2` は認証・認可エラー、`3` は検証エラー、`4` はネットワークエラー、`5` は内部エラーです。 出力やリクエストの設定は[グローバルオプション](https://orchestor.io/docs/cli/global-flags.md)、エージェント用スキルと MCP の設定は[setup](https://orchestor.io/docs/cli/setup.md)を参照してください。 ## 利用できるコマンド `orc --help` でインストール済みのコマンド一覧を確認できます。各コマンドに `--help` を付けると引数とフラグを表示します。データ操作には複数形の名前空間を使い、ローカル設定はそれぞれのコマンドから実行します。 ```bash orc --help orc brands list --help ``` 以下の例は認証とワークスペースの選択が済んでいることを前提とします。`YOUR_*_ID` と `YOUR_PROJECT_KEY` は対応する一覧コマンドで取得した値に置き換えてください。 ### 基本操作 #### auth ブラウザでログインし、API から現在の認証情報を確認します。 ```bash orc auth login orc whoami --json ``` [auth の詳細](https://orchestor.io/docs/cli/auth.md)を参照してください。 #### account ログイン中のアカウントと利用状態を確認します。 ```bash orc whoami orc status ``` [whoami / status の詳細](https://orchestor.io/docs/cli/whoami.md)を参照してください。 #### init 標準入力から API キーを受け取り、CLI を初期化します。 ```bash printf '%s' "$ORCHESTOR_API_KEY" | orc init ``` [init の詳細](https://orchestor.io/docs/cli/init.md)を参照してください。 #### config ローカルの CLI 設定を表示し、設定値を確認・変更します。 ```bash orc config show ``` [config の詳細](https://orchestor.io/docs/cli/config.md)を参照してください。 #### status CLI の認証元やローカルの設定状態を確認します。 ```bash orc status ``` [status の詳細](https://orchestor.io/docs/cli/status.md)を参照してください。 #### setup 同梱のスキルをエージェントへ導入します。MCPの接続には[エージェント接続の手順](https://orchestor.io/docs/cli/workflows/agent-connect.md)を使います。 ```bash orc setup skills --agent codex orc setup skills --agent codex --status ``` [setup の詳細](https://orchestor.io/docs/cli/setup.md)を参照してください。 #### completion 指定したシェル用の補完スクリプトを出力します。 ```bash orc completion bash ``` [completion の詳細](https://orchestor.io/docs/cli/completion.md)を参照してください。 #### update CLI の更新コマンドを実行します。更新方法とオプションは詳細リファレンスで確認できます。 ```bash orc update --help ``` [update の詳細](https://orchestor.io/docs/cli/update.md)を参照してください。 ### ワークスペース #### workspace 利用できるワークスペースを一覧表示し、以降のコマンドで使う対象を選択します。 ```bash orc workspaces list --json orc workspace use YOUR_WORKSPACE_ID orc workspace current ``` [workspace の詳細](https://orchestor.io/docs/cli/workspace.md)を参照してください。 #### workspace-member 指定したワークスペースのメンバーを一覧表示します。 ```bash orc workspaces members list YOUR_WORKSPACE_ID --json ``` [workspace-member の詳細](https://orchestor.io/docs/cli/workspaces.md)を参照してください。 #### project プロジェクトを一覧表示し、プロジェクトキーから詳細を取得します。 ```bash orc projects list --json orc projects get YOUR_PROJECT_KEY --json ``` [project の詳細](https://orchestor.io/docs/cli/project.md)を参照してください。 ### 観測対象 #### brand 分析対象のブランドを一覧表示し、ブランド ID から詳細を取得します。 ```bash orc brands list --json orc brands get YOUR_BRAND_ID --json ``` [brand の詳細](https://orchestor.io/docs/cli/brand.md)を参照してください。 #### product 製品の一覧とサマリーを取得します。 ```bash orc products list --json orc products summary get --json ``` [product の詳細](https://orchestor.io/docs/cli/product.md)を参照してください。 #### domain ワークスペースのドメインを一覧表示します。 ```bash orc domains list --json ``` [domain の詳細](https://orchestor.io/docs/cli/domain.md)を参照してください。 #### persona 分析に使用するペルソナを一覧表示します。 ```bash orc personas list --json ``` [persona の詳細](https://orchestor.io/docs/cli/persona.md)を参照してください。 #### prompt AI に送信するプロンプトを一覧表示し、詳細を取得します。 ```bash orc prompts list --json orc prompts get YOUR_PROMPT_ID --json ``` [prompt の詳細](https://orchestor.io/docs/cli/prompt.md)を参照してください。 #### topic 分析対象のトピックを一覧表示し、詳細を取得します。 ```bash orc topics list --json orc topics get YOUR_TOPIC_ID --json ``` [topic の詳細](https://orchestor.io/docs/cli/topic.md)を参照してください。 #### tag プロンプトの整理に使用するタグを一覧表示します。 ```bash orc tags list --json ``` [tag の詳細](https://orchestor.io/docs/cli/tag.md)を参照してください。 ### 観測 #### answer 収集した AI の回答を一覧表示し、回答 ID から詳細を取得します。 ```bash orc answers list --json orc answers get YOUR_ANSWER_ID --json ``` [answer の詳細](https://orchestor.io/docs/cli/answer.md)を参照してください。 #### source AI の回答で参照されるドメインと URL を一覧表示します。 ```bash orc sources domains list --json orc sources urls list --json ``` [source の詳細](https://orchestor.io/docs/cli/source.md)を参照してください。 #### fanout-query AI の回答に関連するファンアウト検索クエリを一覧表示します。 ```bash orc fanout-queries list --json ``` [fanout-query の詳細](https://orchestor.io/docs/cli/fanout-query.md)を参照してください。 ### 分析 #### analytics ドメインに対する AI クローラーの robots.txt アクセスポリシーを確認します。 ```bash orc analytics crawlability get --json ``` [analytics の詳細](https://orchestor.io/docs/cli/analytics.md)を参照してください。 ### 優先順位 #### issue ワークスペースの Issue を一覧表示し、詳細を取得します。 ```bash orc issues list --json orc issues get YOUR_ISSUE_ID --json ``` [issue の詳細](https://orchestor.io/docs/cli/issue.md)を参照してください。 ### レポート #### report 可視性、引用、センチメントなどのレポートを取得します。`orc report` はダイジェスト用のコマンドです。 ```bash orc reports visibility get --json orc reports citations get --json orc reports sentiment get --json ``` [report の詳細](https://orchestor.io/docs/cli/report.md)を参照してください。 ### 使用量とコスト #### usage 開始日時を指定して API の使用量を取得します。 ```bash orc usage get --start-time 2026-09-01T00:00:00Z --json ``` [usage の詳細](https://orchestor.io/docs/cli/usage.md)を参照してください。 #### cost 開始日時を指定してコストの内訳を取得します。 ```bash orc costs get --start-time 2026-09-01T00:00:00Z --json ``` [cost の詳細](https://orchestor.io/docs/cli/cost.md)を参照してください。 --- [Documentation index](https://orchestor.io/docs/llms.txt)