Orchestor (CLI)

​
Terminal quickstart

Explore how your brand appears in AI search from your terminal. By the end of this guide, you can retrieve brands, tracked questions, and visibility reports, then continue investigating with an agent.

​
Before you begin

  • Open a terminal on macOS, Linux, or Windows. If this is your first time, see the terminal guide.
  • Have an Orchestor account. Create an account if you need one.
  • Have a workspace with brands and tracked questions configured. Follow the Web quickstart for initial setup.

​
Step 1: Install Orchestor CLI

Choose one method for your environment.

The native CLI does not require Node.js. On Alpine Linux, run apk add --no-cache libstdc++ first.

Verify your installation:

orc --version
orc --help

Installation is complete when the version and command list appear. If orc is not found, reopen your terminal and check the installation guide.

​
Step 2: Sign in to your account

orc auth login

Complete sign-in in your browser, then return to the terminal. Check your authentication status:

orc auth status

​
Step 3: Select a workspace

List the workspaces you can access:

orc workspaces list

Copy the ID of the workspace you want to investigate. Replace WORKSPACE_ID with that value:

orc workspace use WORKSPACE_ID
orc workspace current

When your selected workspace appears, you are ready to investigate. Brands and questions already configured on the Web are available here too.

​
Step 4: View your first results

Check your registered brands and tracked questions:

orc brands list
orc prompts list

Then retrieve the visibility report:

orc reports visibility get

If the results are empty, check the workspace, brands, questions, and measurement status in the Web app. Missing data does not mean visibility is zero.

Add --json to use the results in another tool:

orc reports visibility get --json

See key visibility metrics for help interpreting results.

​
Step 5: Investigate with an agent

To continue in Claude Code, Codex, Cursor, or another supported agent, follow the agent setup guide. Ask your connected agent:

Review the questions tracked in this workspace.
Find questions where competitors are mentioned but our brand is missing.
Show the supporting AI answers and cited sources.

Review the results, then narrow your investigation:

Compare the pages cited for those questions.
Identify information missing from our site and suggest which pages to improve next.

​
Essential commands

CommandPurpose
orc --helpList available commands
orc auth statusCheck authentication status
orc workspaces listList accessible workspaces
orc workspace use WORKSPACE_IDSelect a workspace
orc workspace currentCheck the selected workspace
orc brands listCheck registered brands
orc prompts listCheck tracked questions
orc reports visibility getRetrieve the visibility report
orc update --checkCheck the update method and latest version

Append --help to a command for its arguments and options.

​
Next steps

  • CLI workflows: investigate competitors, answers, and sources
  • Agent setup: continue with your preferred agent
  • CLI updates: find the update procedure for your installation method

​
Get help

If orc is missing or starts a different version, run type -a orc on macOS / Linux or Get-Command orc -All in PowerShell. Check which installation is on your PATH.

For sign-in or workspace selection problems, check orc auth status and orc workspace current. If a shared workspace is missing, ask your administrator to confirm access.

See troubleshooting for more help.