---
title: "overlane connector show"
description: "Show one connector: auth, scopes, typed actions with their class, and events"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.overlane.app/llms.txt
> Use this file to discover all available pages before exploring further.

# overlane connector show

{/* Generated by apps/docs/scripts/generate.mjs (CLI pages from the command registry in packages/cli). Do not edit; run `pnpm --filter @overlane/docs gen`. */}

Prints the connector's declaration: how it authenticates, the scopes it asks for, each typed action with its class (read, write or destructive) and the autonomy class a write follows, the settings it takes and the events it can send.

## Usage

```sh
overlane connector show provider [--service URL] [--team TENANT_ID]
```

## Arguments

| Argument | Required | Description |
| --- | --- | --- |
| `provider` | yes | The connector, such as slack or linear (see `overlane connector list`) |

## Flags

| Flag | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `--service` | string | no |  | The service address (default: OVERLANE_SERVICE_URL, then the project's binding, then the hosted service) |
| `--team` | string | no |  | The team (tenant) to act on (default: the one your token belongs to) |

## Examples

```sh
overlane connector show slack
overlane connector show linear --json
```

## Behavior

- Effect: `read` (changes nothing).
- Needs credentials: yes. Uses the network: yes.
- Supports `--dry-run`: no. Accepts `--force`: no.
- Machine-readable description: `overlane schema connector show`.

## Result

With `--json` (the default when stdout is not a terminal) the command prints this JSON Schema's shape on stdout.

```json
{
  "type": "object",
  "properties": {
    "tenantId": {
      "type": "string"
    },
    "provider": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "auth": {
      "type": "string"
    },
    "docsDate": {
      "type": "string"
    },
    "rateLimitPerMinute": {
      "type": "number"
    },
    "actions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "summary": {
            "type": "string"
          },
          "kind": {
            "type": "string",
            "enum": [
              "read",
              "write",
              "destructive"
            ]
          },
          "gateClass": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "name",
          "summary",
          "kind",
          "gateClass"
        ],
        "additionalProperties": false
      }
    },
    "events": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "next": {
      "type": "string"
    }
  },
  "required": [
    "tenantId",
    "provider",
    "name",
    "auth",
    "docsDate",
    "rateLimitPerMinute",
    "actions",
    "events",
    "next"
  ],
  "additionalProperties": false
}
```

See [exit codes](/cli/#exit-codes) for the status the process returns.

Source: https://docs.overlane.app/cli/connector-show/index.mdx