Connectors CLI Reference

Use chainabit connectors when you want the shortest path from the catalog to a working instance.

Install and Explore

chainabit connectors list
chainabit connectors list --category productivity
chainabit connectors list --active --locale tr
chainabit connectors get slack
chainabit connectors install slack --name "Team Slack"

connectors list shows the catalog. connectors install creates an instance in the current workspace.

Example JSON output from connectors list --json:

[
  {
    "key": "slack",
    "displayName": "Slack",
    "category": "communication",
    "authType": "oauth2",
    "supportedFeatures": ["tool_discovery", "health_check"],
    "isActive": true
  }
]

Authenticate an Instance

Browser-based connectors use the default OAuth flow:

chainabit connectors auth inst_123

This path is interactive. In CI or other non-interactive jobs, use a typed credential flag if the connector supports one.

If your connector uses an API key, bearer token, connection string, basic auth, or custom credential payload, pass the typed flag instead:

chainabit connectors auth inst_123 --api-key-env SLACK_API_KEY
chainabit connectors auth inst_123 --token-file ./.secrets/github-token.txt
chainabit connectors auth inst_123 --connection-string-env ANALYTICS_DB_URL
chainabit connectors auth inst_123 --username api-user --password-env CONNECTOR_PASSWORD
chainabit connectors auth inst_123 --custom-file ./.secrets/custom-credentials.json

Use --no-open if you want to copy the OAuth URL manually instead of launching a browser automatically.

Avoid passing connector secrets directly on the command line when possible. Env, stdin, and file-based inputs reduce exposure in shell history and process listings.

Inspect Runtime State

chainabit connectors instances list
chainabit connectors instances get inst_123
chainabit connectors instances update inst_123 --name "Team Slack" --enabled
chainabit connectors test inst_123
chainabit connectors tools inst_123 --locale tr
chainabit connectors executions inst_123 --limit 10

connectors tools shows the tool ids you can execute. connectors executions shows the recent tool run history for an instance.

Execute a Tool

chainabit connectors exec inst_123 send_message \
  --input '{"channel":"#general","text":"Hello from Chainabit!"}'

connectors exec accepts either the tool key or the tool id shown by connectors tools.

Sync Dynamic Connectors

chainabit connectors sync inst_123

Use sync after connecting to a dynamic MCP-style connector so the CLI and API can refresh the tool list.

JSON Scripting

chainabit connectors list --json | jq '.[0].key'
chainabit connectors tools inst_123 --json
chainabit connectors executions inst_123 --json

Suggested Workflow

1. chainabit connectors list
2. chainabit connectors install <key>
3. chainabit connectors auth <instance-id>
4. chainabit connectors test <instance-id>
5. chainabit connectors tools <instance-id>
6. chainabit connectors exec <instance-id> <tool> --input '<json>'

Related API Contracts

• Use Connector Instances API for the request and response DTOs behind install, instances, and test.
• Use Connector Tools API for the schemas returned by tools and sync.
• Use Execute Tool API for the input and output contract behind connectors exec.