Orchestor Documentation

Learn how to get up and running with Orchestor through tutorials, APIs, and platform resources.

Set up your coding agent

Use Orchestor from the agent you work with. This prompt guides CLI installation and login, supported Skills setup, an MCP connection, and your first report.

Agent Prompt
Help me set up Orchestor for this agent. First read https://orchestor.io/docs/en/agent-setup and https://orchestor.io/docs/en/cli/installation for the current official instructions for this OS and agent. 1. Check the existing orc --version and installation method. On macOS / Linux, install the latest stable CLI with curl -fsSL https://orchestor.io/install | sh. On Windows, use the matching ZIP from https://github.com/orchestor-inc/cli/releases/latest. Verify with orc --version and orc --help. Native binaries do not require Node.js. Check for Node.js 24 or later only if choosing the npm package. 2. Start login with orc auth login and guide me through the required browser steps. Verify with orc auth status --json. Do not paste credentials into the conversation. 3. Follow the official guide for this agent. Inspect existing plugins, Skills, MCP settings, and installation scope first. For Claude Code, use the official plugin to add Skills and MCP together. For other agents, follow their respective guides. Avoid overwriting existing settings or registering duplicates. 4. Guide me through browser OAuth for hosted MCP at https://mcp.orchestor.io/mcp. After any required reload, call brands_list to verify the connection. Verify CLI and MCP authentication separately. 5. Run orc workspaces list --json, select the intended workspace, and configure it with orc workspace use WORKSPACE_ID. Verify the selection with orc workspace current --json. 6. Run orc brands list --json and orc reports visibility get --json. Report configuration, authentication, and data retrieval results separately. Explain the returned period, results, and what to investigate next. State explicitly when no data is available.

Prepare your measurements

Choose a guide for the workflow you need.

Understand AI answers

Choose a guide for the workflow you need.

Explore citation sources

Choose a guide for the workflow you need.

Explore more

Explore tools, integrations, and guides to get more from Orchestor.