overlane schema | Overlane Docs

Prints the machine-readable description of one command: every flag and argument with type, required and description; whether it takes –dry-run or –force; its examples; the JSON Schema of its result; and the exit codes. Give a group name (task) to get all its commands.

Usage

overlane schema command...

Arguments

Argument	Required	Description
`command...`	yes	The command path, for example: task start

Examples

overlane schema task start
overlane schema run
overlane schema release rollback

Behavior

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

Result

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

{
  "anyOf": [
    {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    {
      "type": "object",
      "properties": {
        "commands": {
          "type": "array",
          "items": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {}
          }
        }
      },
      "required": [
        "commands"
      ],
      "additionalProperties": false
    }
  ]
}

See exit codes for the status the process returns.