overlane team join | Overlane Docs

Adds you to a team with the link or secret you were sent. Pass the whole link or just the secret. It works once, and only when you are signed in with the verified email address it was sent to. Your own team is left as it is; run overlane team use \<team-id\> to work in the new one.

Usage

overlane team join link [--service URL] [--dry-run]

Arguments

Argument	Required	Description
`link`	yes	The link or secret you were sent (the secret starts ovl_i_)

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)
`--dry-run`	boolean	no		Print the requests and file changes this command would make, then stop. Needs no credentials.

Examples

overlane team join 'https://overlane.app/invite#secret=ovl_i_...'
overlane team join ovl_i_... --dry-run

Behavior

Effect: write (changes local or hosted state).
Needs credentials: yes. Uses the network: yes.
Supports --dry-run: yes. Accepts --force: no.
Machine-readable description: overlane schema team join.

Result

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

{
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "tenantId": {
          "type": "string"
        },
        "role": {
          "type": "string"
        },
        "next": {
          "type": "string"
        }
      },
      "required": [
        "tenantId",
        "role",
        "next"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "dryRun": {
          "type": "boolean",
          "const": true
        },
        "service": {
          "type": "string"
        },
        "requests": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "method": {
                "type": "string"
              },
              "path": {
                "type": "string"
              },
              "body": {},
              "note": {
                "type": "string"
              }
            },
            "required": [
              "method",
              "path"
            ],
            "additionalProperties": false
          }
        },
        "commands": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "writes": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "path": {
                "type": "string"
              },
              "action": {
                "type": "string",
                "enum": [
                  "write",
                  "append",
                  "delete"
                ]
              },
              "description": {
                "type": "string"
              }
            },
            "required": [
              "path",
              "action",
              "description"
            ],
            "additionalProperties": false
          }
        },
        "notes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "dryRun",
        "requests",
        "commands",
        "writes",
        "notes"
      ],
      "additionalProperties": false
    }
  ]
}

See exit codes for the status the process returns.