--- title: Terminal guide description: Open a terminal, install Orchestor CLI, sign in, and retrieve your first data. No previous terminal experience is required. canonical_url: https://orchestor.io/docs/en/terminal-guide markdown_url: https://orchestor.io/docs/en/terminal-guide.md contentType: tutorial --- # Terminal guide This guide is for people using a terminal for the first time. Open a terminal, install Orchestor CLI, and retrieve your brand data. A terminal is an app where you type commands. Copy a command from this page, paste it into your terminal, and press Enter to run it. Run commands one line at a time. > **Note** > > To start in your browser, see the [Web quickstart](https://orchestor.io/docs/en/web-quickstart.md). The CLI also requires an Orchestor account. If you are new, [create an account](https://orchestor.io/signup) first. ## macOS and Linux 1. **Open a terminal** On macOS, press Command + Space to open Spotlight, type Terminal, and press Enter. On Linux, open the terminal from your application menu. Some environments also support Ctrl + Alt + T. When you see a cursor where you can type, you are ready. Paste commands with Command + V on macOS or Ctrl + Shift + V in many Linux terminals. 2. **Check Node.js** These npm/pnpm installation steps require Node.js 24 or later. ```bash node --version npm --version ``` If Node.js is missing or older than version 24, install version 24 or later from the [official Node.js website](https://nodejs.org/en/download). Open a new terminal window and check again. 3. **Install Orchestor CLI** Choose npm unless you already use pnpm. Copy the command shown below and run it in your terminal. ```sh curl -fsSL https://orchestor.io/install | sh ``` After installation, check the CLI version: ```bash orc --version ``` 4. **Sign in** ```bash orc auth login ``` Complete sign-in in the browser that opens, then return to your terminal. ```bash orc auth status --json ``` Once authentication is confirmed, continue to Retrieve your first data below. ## Windows 1. **Open PowerShell** Search for PowerShell in the Start menu and open it. If you use Windows Terminal, select a PowerShell tab. Paste commands with Ctrl + V or a right-click, then press Enter to run them. 2. **Check Node.js** ```powershell node --version npm --version ``` These npm installation steps require Node.js 24 or later. If it is missing or older than version 24, install version 24 or later for Windows from the [official Node.js website](https://nodejs.org/en/download). Open a new PowerShell window and check again. 3. **Install Orchestor CLI** Choose npm unless you already use pnpm. You can switch package managers in the menu. ```sh curl -fsSL https://orchestor.io/install | sh ``` Run the displayed command, then check the CLI version: ```powershell orc --version ``` 4. **Sign in** ```powershell orc auth login ``` Complete sign-in in your browser, then return to PowerShell. ```powershell orc auth status --json ``` ## Retrieve your first data 1. **List your workspaces** ```bash orc workspaces list ``` Find the ID of the workspace containing the brand you want to investigate. 2. **Select a workspace** Replace `WORKSPACE_ID` with an ID from the list. ```bash orc workspace use WORKSPACE_ID ``` 3. **Retrieve the brand list** ```bash orc brands list --json ``` A returned brand list confirms that the CLI can retrieve data. If the list is empty, check the selected workspace and whether a brand has been registered. If setup is incomplete, follow [Web setup](https://orchestor.io/docs/en/web-quickstart.md) or the [CLI first measurement guide](https://orchestor.io/docs/en/cli/workflows/onboarding.md). Orchestor CLI runs one command at a time. When a command finishes, you can enter the next one. Press Ctrl + C to interrupt a running command. To see available commands, run: ```bash orc --help ``` ## Next steps ### Retrieve prompts and reports Retrieve prompts and the visibility report for the selected workspace: ```bash orc prompts list --json orc reports visibility get --json ``` Add `--help` to a command to see how to use it. ### Investigate with an agent To ask Claude Code, Codex, Cursor, or another agent to investigate in natural language, follow the [agent connection guide](https://orchestor.io/docs/en/cli/workflows/agent-connect.md). CLI login and MCP authentication are separate. ### Explore other workflows - [CLI quickstart](https://orchestor.io/docs/en/cli/quickstart.md): authentication, workspace selection, and data retrieval - [CLI workflows](https://orchestor.io/docs/en/cli/workflows.md): investigate answers, competitors, and citations - [Where to use Orchestor](https://orchestor.io/docs/en/platforms.md): choose between Web and CLI ## Troubleshooting ### macOS and Linux ### node or npm is not found Finish installing Node.js and open a new terminal window. Confirm that `node --version` and `npm --version` work before installing the CLI. ### command not found: orc Check that CLI installation completed without an error. If a new terminal window still cannot find the command, check that the installation directory for your package manager is on PATH. See [setup troubleshooting](https://orchestor.io/docs/en/cli/workflows/setup-troubleshooting.md) for details. ### Windows ### node, npm, or orc is not recognized Check the Node.js and CLI installation results, then open a new PowerShell window. Run `node --version`, `npm --version`, and `orc --version` in that order to identify which command is missing. ### npm.ps1 or orc.ps1 cannot run If PowerShell execution policy restricts scripts, open Command Prompt from the Start menu and run the same npm or orc command there. For sign-in or data retrieval failures, use [setup troubleshooting](https://orchestor.io/docs/en/cli/workflows/setup-troubleshooting.md) to identify the stage that failed. --- [Documentation index](https://orchestor.io/docs/llms.txt)