overlane run claim | Overlane Docs

Claims a task under the active run and prints its contract and verification commands. A stop (policy paused, a budget spent, nothing runnable) exits 6 with the reason in the error code and the exact overlane run end --reason ... as the hint.

Usage

overlane run claim [task-id] [--dry-run]

Arguments

Argument	Required	Description
`task-id`	no	The task to claim (default: the next runnable one)

Flags

Flag	Type	Required	Default	Description
`--dry-run`	boolean	no		Print the requests and file changes this command would make, then stop. Needs no credentials.

Examples

overlane run claim
overlane run claim T003

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 run claim.

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": {
        "runId": {
          "type": "string"
        },
        "taskId": {
          "type": "string"
        },
        "outcome": {
          "type": "string"
        },
        "allowedPaths": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "acceptanceCriteria": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "verificationCommands": {
          "anyOf": [
            {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "planFile": {
          "type": "string"
        }
      },
      "required": [
        "runId",
        "taskId",
        "outcome",
        "allowedPaths",
        "acceptanceCriteria",
        "verificationCommands",
        "planFile"
      ],
      "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.