Orchestor CLI
Orchestor CLI lets you work with brands, prompts, AI answers, and reports from a terminal, a CI/CD pipeline, or an AI agent. Commands can return JSON for scripts and CSV for data analysis.
This reference covers the CLI 0.5.0 release target. orc and orchestor start the same CLI.
Choose what you want to start
| Goal | Guide |
|---|---|
| Use Orchestor for the first time | Account creation, email verification, and invitation |
| Authenticate a terminal with an existing account | Sign in from the CLI |
| Start another target with the same account | Create a workspace |
| Set up a brand and obtain the first results | Run the first observation |
| Operate from Codex or Claude Code | Connect an agent |
| Run repeated jobs in CI | Configure API credentials and CI permissions |
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.
curl -fsSL https://orchestor.io/install | shUpdating Orchestor CLI
Update a CLI installed with the macOS/Linux installer:
orc updateSee the release notes.
Checking your version
Use --version to print the installed version.
orc --versionPrint 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.
orc brands list --workspace "$ORCHESTOR_WORKSPACE_ID" --json
orc reports visibility get --workspace "$ORCHESTOR_WORKSPACE_ID" --jsonRead 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 for output and request controls, and setup 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. In 0.5.0, data commands use plural namespaces and local utilities use their public command names.
orc --help
orc brands list --helpThe 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.
orc auth login
orc whoami --jsonLearn more about auth.
account
Inspect the signed-in account and its status.
orc whoami
orc statusLearn more about whoami / status.
init
Initialize the CLI with an API key from standard input.
printf '%s' "$ORCHESTOR_API_KEY" | orc initLearn more about init.
config
Inspect and change local CLI configuration.
orc config showLearn more about config.
status
Inspect the CLI credential source and local configuration status.
orc statusLearn more about status.
setup
Install bundled skills for an agent. To connect MCP, follow the agent connection guide.
orc setup skills --agent codex
orc setup skills --agent codex --statusLearn more about setup.
completion
Print a completion script for the specified shell.
orc completion bashLearn more about completion.
update
Run the CLI updater. See the command reference for update options.
orc update --helpLearn more about update.
Workspaces
workspace
List available workspaces and select the default for subsequent commands.
orc workspaces list --json
orc workspace use YOUR_WORKSPACE_ID
orc workspace currentLearn more about workspace.
workspace-member
List members of the specified workspace.
orc workspaces members list YOUR_WORKSPACE_ID --jsonLearn more about workspace-member.
project
List projects and retrieve a project by key.
orc projects list --json
orc projects get YOUR_PROJECT_KEY --jsonLearn more about project.
Tracking scope
brand
List the brands you track and retrieve a brand by ID.
orc brands list --json
orc brands get YOUR_BRAND_ID --jsonLearn more about brand.
product
Retrieve the product catalog and its summary.
orc products list --json
orc products summary get --jsonLearn more about product.
domain
List workspace domains.
orc domains list --jsonLearn more about domain.
persona
List personas used in your analysis.
orc personas list --jsonLearn more about persona.
prompt
List prompts sent to AI models and retrieve prompt details.
orc prompts list --json
orc prompts get YOUR_PROMPT_ID --jsonLearn more about prompt.
topic
List tracked topics and retrieve their details.
orc topics list --json
orc topics get YOUR_TOPIC_ID --jsonLearn more about topic.
tag
List tags used to organize prompts.
orc tags list --jsonLearn more about tag.
Observe
answer
List collected AI answers and retrieve an answer by ID.
orc answers list --json
orc answers get YOUR_ANSWER_ID --jsonLearn more about answer.
source
List domains and URLs referenced in AI answers.
orc sources domains list --json
orc sources urls list --jsonLearn more about source.
fanout-query
List fanout search queries associated with AI answers.
orc fanout-queries list --jsonLearn more about fanout-query.
Understand
analytics
Check the robots.txt access policy for AI crawlers on a domain.
orc analytics crawlability get --jsonLearn more about analytics.
Prioritize
issue
List workspace issues and retrieve their details.
orc issues list --json
orc issues get YOUR_ISSUE_ID --jsonLearn more about issue.
Report
report
Retrieve visibility, citation, and sentiment reports. Use orc report for a digest.
orc reports visibility get --json
orc reports citations get --json
orc reports sentiment get --jsonLearn more about report.
Usage and cost
usage
Retrieve API usage for a range beginning at the specified timestamp.
orc usage get --start-time 2026-09-01T00:00:00Z --jsonLearn more about usage.
cost
Retrieve cost attribution for a range beginning at the specified timestamp.
orc costs get --start-time 2026-09-01T00:00:00Z --jsonLearn more about cost.