--- title: Orchestor CLI description: Install, authenticate, automate, and explore every Orchestor CLI command. canonical_url: https://orchestor.io/docs/en/cli markdown_url: https://orchestor.io/docs/en/cli.md contentType: reference --- # Orchestor CLI Orchestor CLI lets you work with [brands](https://orchestor.io/docs/en/cli/brand.md), [prompts](https://orchestor.io/docs/en/cli/prompt.md), [AI answers](https://orchestor.io/docs/en/cli/answer.md), and [reports](https://orchestor.io/docs/en/cli/report.md) from a terminal, a CI/CD pipeline, or an AI agent. Commands can return JSON for scripts and CSV for data analysis. This reference describes the current CLI implementation in the repository. `orc` and `orchestor` start the same CLI. Check the installed version’s `--help` output for features included in the published package. See [Search Console CLI](https://orchestor.io/docs/en/cli/search-console.md) for commands in development to read search performance, URL indexing status, and sitemaps. See [Sheets CLI](https://orchestor.io/docs/en/cli/sheets.md) for commands that let agents read and write Google Sheets structure, values, and native Tables. See [Slides CLI](https://orchestor.io/docs/en/cli/slides.md) to select a connection with `--target`, read and create presentations, and call the Slides API. ## Choose what you want to start | Goal | Guide | | --- | --- | | Use Orchestor for the first time | [Account creation, email verification, and invitation](https://orchestor.io/signup) | | Authenticate a terminal with an existing account | [Sign in from the CLI](https://orchestor.io/docs/cli/quickstart.md) | | Start another target with the same account | [Create a workspace](https://orchestor.io/docs/cli/workflows/new-workspace.md) | | Set up a brand and obtain the first results | [Run the first observation](https://orchestor.io/docs/cli/workflows/onboarding.md) | | Operate from Codex or Claude Code | [Connect an agent](https://orchestor.io/docs/cli/workflows/agent-connect.md) | | Run repeated jobs in CI | [Configure API credentials and CI permissions](https://orchestor.io/docs/cli/workflows/ci-setup.md) | Account registration, workspace creation, and first observation are separate operations. You do not need another account for every new target. ## Installing Orchestor CLI On macOS and Linux, install with one command. Node.js is not required. ```sh curl -fsSL https://orchestor.io/install | sh ``` [Windows, Alpine Linux, and other installation methods](https://orchestor.io/docs/en/cli/installation.md). See the [quickstart for authentication and workspace selection](https://orchestor.io/docs/en/cli/quickstart.md). ## Updating Orchestor CLI Update a CLI installed with the macOS/Linux installer: ```sh orc update ``` See the [release notes](https://orchestor.io/docs/en/cli/release-notes.md). ## Checking your version Use `--version` to print the installed version. ```bash orc --version ``` *Print the version before choosing the matching command reference.* ## Using Orchestor CLI in CI/CD and AI agents For interactive use, run `orc auth login`. In CI/CD or an agent runtime, provide `ORCHESTOR_API_KEY` through your secret manager. The environment variable takes precedence over stored CLI credentials. Set `ORCHESTOR_WORKSPACE_ID` in your runtime to the target workspace ID, then pass it explicitly with `--workspace`. Request JSON when another program will read the result. ```bash orc brands list --workspace "$ORCHESTOR_WORKSPACE_ID" --json orc reports visibility get --workspace "$ORCHESTOR_WORKSPACE_ID" --json ``` *Read data from stdout. Keep stderr separate for diagnostics.* Branch on the exit code instead of parsing error messages: `0` means success, `1` an API or external service error, `2` an authentication or authorization error, `3` a validation error, `4` a network error, and `5` an internal error. See [global options](https://orchestor.io/docs/en/cli/global-flags.md) for output and request controls, and [setup](https://orchestor.io/docs/en/cli/setup.md) for agent skills and MCP configuration. ## Available commands Use `orc --help` for the installed command catalog and append `--help` to a command for its arguments and flags. Data commands use plural namespaces, and local utilities use their own command names. ```bash orc --help orc brands list --help ``` The examples below assume authentication and a selected workspace. Replace `YOUR_*_ID` and `YOUR_PROJECT_KEY` with values from the corresponding list command. ### General #### auth Sign in through the browser and inspect the current API identity. ```bash orc auth login orc whoami --json ``` Learn more about [auth](https://orchestor.io/docs/en/cli/auth.md). #### account Inspect the signed-in account and its status. ```bash orc whoami orc status ``` Learn more about [whoami / status](https://orchestor.io/docs/en/cli/whoami.md). #### init Initialize the CLI with an API key from standard input. ```bash printf '%s' "$ORCHESTOR_API_KEY" | orc init ``` Learn more about [init](https://orchestor.io/docs/en/cli/init.md). #### config Inspect and change local CLI configuration. ```bash orc config show ``` Learn more about [config](https://orchestor.io/docs/en/cli/config.md). #### status Inspect the CLI credential source and local configuration status. ```bash orc status ``` Learn more about [status](https://orchestor.io/docs/en/cli/status.md). #### setup Install bundled skills for an agent. To connect MCP, follow the [agent connection guide](https://orchestor.io/docs/cli/workflows/agent-connect.md). ```bash orc setup skills --agent codex orc setup skills --agent codex --status ``` Learn more about [setup](https://orchestor.io/docs/en/cli/setup.md). #### completion Print a completion script for the specified shell. ```bash orc completion bash ``` Learn more about [completion](https://orchestor.io/docs/en/cli/completion.md). #### update Run the CLI updater. See the command reference for update options. ```bash orc update --help ``` Learn more about [update](https://orchestor.io/docs/en/cli/update.md). ### Workspaces #### workspace List available workspaces and select the default for subsequent commands. ```bash orc workspaces list --json orc workspace use YOUR_WORKSPACE_ID orc workspace current ``` Learn more about [workspace](https://orchestor.io/docs/en/cli/workspace.md). #### workspace-member List members of the specified workspace. ```bash orc workspaces members list YOUR_WORKSPACE_ID --json ``` Learn more about [workspace-member](https://orchestor.io/docs/en/cli/workspaces.md). #### project List projects and retrieve a project by key. ```bash orc projects list --json orc projects get YOUR_PROJECT_KEY --json ``` Learn more about [project](https://orchestor.io/docs/en/cli/project.md). ### Tracking scope #### brand List the brands you track and retrieve a brand by ID. ```bash orc brands list --json orc brands get YOUR_BRAND_ID --json ``` Learn more about [brand](https://orchestor.io/docs/en/cli/brand.md). #### product Retrieve the product catalog and its summary. ```bash orc products list --json orc products summary get --json ``` Learn more about [product](https://orchestor.io/docs/en/cli/product.md). #### domain List workspace domains. ```bash orc domains list --json ``` Learn more about [domain](https://orchestor.io/docs/en/cli/domain.md). #### persona List personas used in your analysis. ```bash orc personas list --json ``` Learn more about [persona](https://orchestor.io/docs/en/cli/persona.md). #### prompt List prompts sent to AI models and retrieve prompt details. ```bash orc prompts list --json orc prompts get YOUR_PROMPT_ID --json ``` Learn more about [prompt](https://orchestor.io/docs/en/cli/prompt.md). #### topic List tracked topics and retrieve their details. ```bash orc topics list --json orc topics get YOUR_TOPIC_ID --json ``` Learn more about [topic](https://orchestor.io/docs/en/cli/topic.md). #### tag List tags used to organize prompts. ```bash orc tags list --json ``` Learn more about [tag](https://orchestor.io/docs/en/cli/tag.md). ### Observe #### answer List collected AI answers and retrieve an answer by ID. ```bash orc answers list --json orc answers get YOUR_ANSWER_ID --json ``` Learn more about [answer](https://orchestor.io/docs/en/cli/answer.md). #### source List domains and URLs referenced in AI answers. ```bash orc sources domains list --json orc sources urls list --json ``` Learn more about [source](https://orchestor.io/docs/en/cli/source.md). #### fanout-query List fanout search queries associated with AI answers. ```bash orc fanout-queries list --json ``` Learn more about [fanout-query](https://orchestor.io/docs/en/cli/fanout-query.md). ### Understand #### analytics Check the robots.txt access policy for AI crawlers on a domain. ```bash orc analytics crawlability get --json ``` Learn more about [analytics](https://orchestor.io/docs/en/cli/analytics.md). ### Prioritize #### issue List workspace issues and retrieve their details. ```bash orc issues list --json orc issues get YOUR_ISSUE_ID --json ``` Learn more about [issue](https://orchestor.io/docs/en/cli/issue.md). ### Report #### report Retrieve visibility, citation, and sentiment reports. Use `orc report` for a digest. ```bash orc reports visibility get --json orc reports citations get --json orc reports sentiment get --json ``` Learn more about [report](https://orchestor.io/docs/en/cli/report.md). ### Usage and cost #### usage Retrieve API usage for a range beginning at the specified timestamp. ```bash orc usage get --start-time 2026-09-01T00:00:00Z --json ``` Learn more about [usage](https://orchestor.io/docs/en/cli/usage.md). #### cost Retrieve cost attribution for a range beginning at the specified timestamp. ```bash orc costs get --start-time 2026-09-01T00:00:00Z --json ``` Learn more about [cost](https://orchestor.io/docs/en/cli/cost.md). --- [Documentation index](https://orchestor.io/docs/llms.txt)