Orbyt Intelligence CLI.

The CLI is in private preview and not yet on a public package registry. Everything it does runs today over the REST API, which you can call from any shell. Public npm, Homebrew, and curl installers land at general availability.

Generate a key in the dashboard, then call the API directly. The API docs have copy-paste examples in cURL, JavaScript, and Python.

Run orbyt login and paste your API key when prompted. Keys are stored at ~/.orbyt/config.json with mode 0600 (owner-only read/write). The key is re-used across every command in the session.

In CI/CD, skip orbyt login and pass the key via env var or flag.

Restricted API keys with per-engine scopes are supported. A key with only intelligence:read can hit orbyt salaries calculate but not orbyt salaries skills (which needs skills:read).

Run orbyt mcp serve to start the MCP server over stdio, using your CLI's authentication. Drop this into Claude Code's mcp.jsonor any agent's MCP config to grant the agent access to the six locked Decision-Ready tools. The server negotiates official MCP protocol versions (2025-11-25 through 2024-11-05), so official-SDK clients such as Claude Code and Claude Desktop complete the handshake. No CLI install? The hosted endpoint works through the mcp-remote bridge; the MCP integration page has that config.

The CLI keeps the stdio process running, handles request cancellation and reconnection, and reports telemetry to a local log file at ~/.orbyt/mcp.log. See the MCP integration page for the full tool catalog and Decision-Ready Response shape.

When testing webhook handlers locally, run orbyt webhooks listen --forward-to=http://localhost:3000/api/webhooks/orbyt and the CLI opens a secure tunnel that forwards every webhook delivery from your Orbyt account to your local server. Signature headers and event payloads come through unchanged so signature verification works end-to-end.

Signatures are computed against your Orbyt webhook signing secret and forwarded unchanged. Run orbyt webhooks verify [event-id]to re-verify a specific delivery's signature after the fact.

For exports, batch lookups, and CSV ingestion, use orbyt salaries export. The command paginates the API, writes CSV or JSON Lines, and respects rate limits (auto-throttles when X-RateLimit-Remaining approaches zero).

Rate-limit handling is transparent. The CLI watches X-RateLimit-Remaining and X-RateLimit-Reset headers and auto-throttles. Failed requests retry up to 3 times with exponential backoff. Requests that ultimately fail are written to --failed-output=failures.csv so you can re-run them later.

The CLI is designed for CI scripts. Exit codes are stable: 0 on success, 1 on API errors, 2 on usage errors, 3 on auth errors, 4 on rate-limit errors that exhausted retries. Pipelines can branch on the result.

For long-running jobs, use orbyt jobs submit and orbyt jobs status to offload export work to the server-side bulk endpoint. Available on the Ultra tier.