oc CLI

oc is the first-party command-line client for Open Connector. It uses the native /api/v1 API through @open-connector/sdk, prints JSON by default for agents and scripts, and can switch to readable terminal output with --human.

Install

curl -fsSL https://github.com/openconnector-dev/openconnector/releases/latest/download/install.sh | sh

The installer downloads a runtime-free binary for macOS or Linux to ~/.local/bin. Windows users can download oc-windows-x64.exe from the GitHub Releases page.

Log in to an instance

Create a project-scoped API key in the SaaS console, then store the broker origin, key, and optional default entity ID:

oc login \
  --url https://api.openconnector.dev \
  --key "$OPEN_CONNECTOR_API_KEY" \
  --entity user_123

This writes ~/.config/oc/config.json. login stores an existing project key; it is not an OAuth login flow. For self-hosting, pass your own public server origin.

Connect and execute

# 1. Inspect the toolkit and copy an exact auth method id
oc toolkits info github

# 2. Create an auth config
oc auth-configs create github \
  --auth-method github.oauth2 \
  --name production

# 3. Connect the current entity; OAuth opens an authorization URL
oc connected-accounts link github --auth-config ac_...

# 4. Inspect and execute tools
oc tools list github
oc tools info GITHUB_CREATE_AN_ISSUE
oc tools execute GITHUB_CREATE_AN_ISSUE \
  --connected-account conn_... \
  --data '{"owner":"acme","repo":"app","title":"Created by oc"}'

For API-key or Basic providers, supply the credential object instead of completing an OAuth redirect:

oc connected-accounts link telegram \
  --auth-method telegram.api_key \
  --credentials '{"apiKey":"..."}'

Commands

Command	Purpose
`oc toolkits list` / `info <slug>`	Browse toolkit metadata and exact auth method IDs
`oc tools list [toolkit]` / `info <slug>`	Discover tools and inspect an input schema
`oc tools execute <slug> --data <input>`	Execute a tool for an entity or connected account
`oc auth-configs create <toolkit> --auth-method <id>`	Create a managed or bring-your-own auth config
`oc auth-configs list` / `info <id>`	Find and inspect auth configs
`oc connected-accounts link <toolkit>`	Start OAuth or submit API-key/Basic credentials
`oc connected-accounts list` / `info <id>` / `delete <id>`	Manage project-scoped connections
`oc proxy <url> --connection <id>`	Make a curl-like request with brokered credentials

Use oc <command> --help for every option. Global flags are --entity <id> and --human.

JSON input and output

--data and --credentials accept inline JSON, @path/to/file.json, or - for stdin:

oc tools execute TOOL_SLUG --data @input.json
cat input.json | oc tools execute TOOL_SLUG --data -
oc --human toolkits list

JSON is the default output so agents and shell scripts can consume stable data. --human is intended for interactive inspection.

Current boundary

The CLI covers toolkit and tool discovery, auth configs, connected accounts, execution, and credential proxying. Triggers, webhooks, an inline JavaScript sandbox, semantic search, and OAuth-based cloud login are not part of the current CLI surface.