overlane workspace channel

Show or set the build your workspace sees: stable or beta, and whether everyone stays on stable

With no channel and no flag it shows the workspace’s channel and whether everyone is kept on stable. With stable or beta it sets the channel. –lock keeps everyone in the workspace on stable whatever they choose; –unlock lets them choose again. An agent token for the team can change it, as can a person who manages the workspace’s policy.

Usage

overlane workspace channel [channel] [--lock] [--unlock] [--dry-run]

Arguments

Argument	Required	Description
`channel`	no	stable or beta

Flags

Flag	Type	Required	Description
`--lock`	boolean	no	Keep everyone in the workspace on stable
`--unlock`	boolean	no	Let people choose their own build again
`--dry-run`	boolean	no	Print the requests and file changes this command would make, then stop. Needs no credentials.

Examples

overlane workspace channel
overlane workspace channel beta
overlane workspace channel stable --lock

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 workspace channel.

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"
        },
        "channel": {
          "type": "string",
          "enum": [
            "stable",
            "beta",
            "internal"
          ]
        },
        "locked": {
          "type": "boolean"
        }
      },
      "required": [
        "tenantId",
        "channel",
        "locked"
      ],
      "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.