Skip to content
Docs

overlane task capsule

Show a task as an open, versioned capsule

Updated View as MarkdownOpen in ChatGPTOpen in Claude

Prints the task’s capsule: its identity and digest, goal, what done means, constraints, state, lease, latest checkpoint and which executors may pick it up. Any reader of the project may fetch it; the rendered payload sections need the lease (overlane task payload).

Usage

overlane task capsule task-id

Arguments

Argument Required Description
task-id yes The task ID from overlane task list

Examples

overlane task capsule task-12
overlane task capsule task-12 --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 task capsule.

Result

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

{
  "type": "object",
  "properties": {
    "$schema": {
      "type": "string"
    },
    "capsuleVersion": {
      "type": "string",
      "const": "1"
    },
    "identity": {
      "$ref": "#/$defs/Identity"
    },
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "goal": {
      "$ref": "#/$defs/Goal"
    },
    "doneWhen": {
      "$ref": "#/$defs/DoneWhen"
    },
    "constraints": {
      "$ref": "#/$defs/Constraints"
    },
    "targets": {
      "maxItems": 20,
      "type": "array",
      "items": {
        "$ref": "#/$defs/Target"
      }
    },
    "state": {
      "type": "string",
      "enum": [
        "ready",
        "running",
        "blocked",
        "paused",
        "verification_pending",
        "verified",
        "failed",
        "cancelled"
      ]
    },
    "pauseReason": {
      "type": "string",
      "enum": [
        "quota",
        "handoff",
        "user",
        "stuck"
      ]
    },
    "source": {
      "$ref": "#/$defs/Source"
    },
    "lease": {
      "anyOf": [
        {
          "$ref": "#/$defs/Lease"
        },
        {
          "type": "null"
        }
      ]
    },
    "checkpoint": {
      "anyOf": [
        {
          "$ref": "#/$defs/Checkpoint"
        },
        {
          "type": "null"
        }
      ]
    },
    "handoff": {
      "$ref": "#/$defs/Handoff"
    },
    "payload": {
      "$ref": "#/$defs/PayloadRefs"
    },
    "issuedAt": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
    },
    "extensions": {
      "type": "object",
      "propertyNames": {
        "type": "string",
        "pattern": "^x-[a-z0-9][a-z0-9-]*$"
      },
      "additionalProperties": {}
    }
  },
  "required": [
    "capsuleVersion",
    "identity",
    "title",
    "goal",
    "doneWhen",
    "constraints",
    "state",
    "source",
    "lease",
    "checkpoint",
    "handoff",
    "payload",
    "issuedAt"
  ],
  "additionalProperties": false,
  "$defs": {
    "Identity": {
      "type": "object",
      "properties": {
        "tenantId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 64
        },
        "projectId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 64
        },
        "taskId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 64
        },
        "capsuleId": {
          "type": "string",
          "pattern": "^cap_[A-Za-z0-9_-]{1,64}_r[0-9]{1,6}$"
        },
        "revision": {
          "type": "object",
          "properties": {
            "contract": {
              "type": "integer",
              "exclusiveMinimum": 0,
              "maximum": 9007199254740991
            },
            "intent": {
              "type": "object",
              "properties": {
                "revision": {
                  "type": "integer",
                  "exclusiveMinimum": 0,
                  "maximum": 9007199254740991
                },
                "digest": {
                  "type": "string",
                  "pattern": "^sha256:[0-9a-f]{64}$"
                },
                "requirementIds": {
                  "minItems": 1,
                  "type": "array",
                  "items": {
                    "type": "string",
                    "maxLength": 48,
                    "pattern": "^[A-Z][A-Z0-9]*(?:-[A-Z0-9]+)+$"
                  }
                }
              },
              "required": [
                "revision",
                "digest",
                "requirementIds"
              ],
              "additionalProperties": false
            }
          },
          "required": [
            "contract"
          ],
          "additionalProperties": false
        },
        "digest": {
          "type": "string",
          "pattern": "^sha256:[0-9a-f]{64}$"
        }
      },
      "required": [
        "tenantId",
        "projectId",
        "taskId",
        "capsuleId",
        "revision",
        "digest"
      ],
      "additionalProperties": false
    },
    "Goal": {
      "type": "object",
      "properties": {
        "outcome": {
          "type": "string",
          "minLength": 12,
          "maxLength": 500
        },
        "whyNow": {
          "type": "string",
          "maxLength": 500
        },
        "nonGoals": {
          "maxItems": 10,
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          }
        }
      },
      "required": [
        "outcome",
        "nonGoals"
      ],
      "additionalProperties": false
    },
    "DoneWhen": {
      "type": "object",
      "properties": {
        "criteria": {
          "minItems": 1,
          "maxItems": 20,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z0-9]+(?:[_-][a-z0-9]+)*$"
              },
              "text": {
                "type": "string",
                "minLength": 1,
                "maxLength": 1000
              },
              "requirementIds": {
                "type": "array",
                "items": {
                  "type": "string",
                  "maxLength": 48,
                  "pattern": "^[A-Z][A-Z0-9]*(?:-[A-Z0-9]+)+$"
                }
              }
            },
            "required": [
              "id",
              "text"
            ],
            "additionalProperties": false
          }
        },
        "checks": {
          "maxItems": 50,
          "type": "array",
          "items": {
            "$ref": "#/$defs/RequiredCheck"
          }
        },
        "noChecks": {
          "type": "object",
          "properties": {
            "reason": {
              "type": "string",
              "minLength": 8,
              "maxLength": 300
            }
          },
          "required": [
            "reason"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "criteria"
      ],
      "additionalProperties": false
    },
    "RequiredCheck": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "maxLength": 64,
          "pattern": "^[a-z0-9]+(?:[_-][a-z0-9]+)*$"
        },
        "definitionDigest": {
          "type": "string",
          "pattern": "^sha256:[0-9a-f]{64}$"
        },
        "minEvidenceLevel": {
          "type": "string",
          "enum": [
            "L1",
            "L2",
            "L3",
            "H"
          ]
        },
        "producers": {
          "minItems": 1,
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "overlane-ci",
              "github-checks",
              "caller"
            ]
          }
        }
      },
      "required": [
        "id",
        "minEvidenceLevel",
        "producers"
      ],
      "additionalProperties": false
    },
    "Constraints": {
      "type": "object",
      "properties": {
        "allowedPaths": {
          "minItems": 1,
          "maxItems": 50,
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 256
          }
        },
        "prohibitedActions": {
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^[a-z]+(?:_[a-z]+)*$"
          }
        },
        "dependsOn": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          }
        },
        "executorsAllowed": {
          "minItems": 1,
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^(?:claude-code|codex|gemini-cli|cursor|model:[a-z0-9][a-z0-9-]{0,47})$"
          }
        },
        "branch": {
          "type": "string",
          "pattern": "^wip\\/[A-Za-z0-9._/-]{1,120}$"
        },
        "budget": {
          "type": "object",
          "properties": {
            "maxMinutes": {
              "type": "integer",
              "minimum": 5,
              "maximum": 720
            },
            "maxIterations": {
              "type": "integer",
              "minimum": 1,
              "maximum": 50
            },
            "maxTokens": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            "maxUsd": {
              "type": "number",
              "minimum": 0
            }
          },
          "additionalProperties": false
        }
      },
      "required": [
        "allowedPaths",
        "prohibitedActions",
        "dependsOn",
        "executorsAllowed",
        "branch"
      ],
      "additionalProperties": false
    },
    "Target": {
      "type": "object",
      "properties": {
        "path": {
          "type": "string",
          "minLength": 1,
          "maxLength": 256
        },
        "symbol": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "lines": {
          "minItems": 2,
          "maxItems": 2,
          "type": "array",
          "items": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 9007199254740991
          }
        },
        "reason": {
          "type": "string",
          "minLength": 8,
          "maxLength": 200
        }
      },
      "required": [
        "path",
        "reason"
      ],
      "additionalProperties": false
    },
    "Source": {
      "type": "object",
      "properties": {
        "commitSha": {
          "type": "string",
          "pattern": "^(?:[0-9a-f]{40}|[0-9a-f]{64})$"
        },
        "workingTreeDigest": {
          "type": "string",
          "pattern": "^sha256:[0-9a-f]{64}$"
        },
        "baseBranch": {
          "type": "string",
          "minLength": 1,
          "maxLength": 120
        }
      },
      "required": [
        "commitSha"
      ],
      "additionalProperties": false
    },
    "Lease": {
      "type": "object",
      "properties": {
        "holder": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128
        },
        "executor": {
          "type": "string",
          "pattern": "^(?:claude-code|codex|gemini-cli|cursor|model:[a-z0-9][a-z0-9-]{0,47})$"
        },
        "fencingToken": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "expiresAt": {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
        }
      },
      "required": [
        "holder",
        "executor",
        "fencingToken",
        "expiresAt"
      ],
      "additionalProperties": false
    },
    "Checkpoint": {
      "type": "object",
      "properties": {
        "createdAt": {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
        },
        "executor": {
          "type": "string",
          "pattern": "^(?:claude-code|codex|gemini-cli|cursor|model:[a-z0-9][a-z0-9-]{0,47})$"
        },
        "summary": {
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        },
        "nextAction": {
          "type": "string",
          "minLength": 1,
          "maxLength": 500
        },
        "commitSha": {
          "type": "string",
          "pattern": "^(?:[0-9a-f]{40}|[0-9a-f]{64})$"
        },
        "workingTreeDigest": {
          "type": "string",
          "pattern": "^sha256:[0-9a-f]{64}$"
        },
        "route": {
          "type": "string",
          "enum": [
            "same_working_tree",
            "exact_commit",
            "authorised_patch"
          ]
        },
        "localOnly": {
          "type": "boolean"
        },
        "failure": {
          "type": "object",
          "properties": {
            "checkId": {
              "type": "string",
              "maxLength": 64,
              "pattern": "^[a-z0-9]+(?:[_-][a-z0-9]+)*$"
            },
            "fingerprint": {
              "type": "string",
              "pattern": "^sha256:[0-9a-f]{64}$"
            }
          },
          "required": [
            "checkId",
            "fingerprint"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "createdAt",
        "executor",
        "summary",
        "nextAction",
        "commitSha",
        "localOnly"
      ],
      "additionalProperties": false
    },
    "Handoff": {
      "type": "object",
      "properties": {
        "onLimit": {
          "anyOf": [
            {
              "type": "string",
              "const": "pause"
            },
            {
              "minItems": 1,
              "type": "array",
              "items": {
                "type": "string",
                "pattern": "^(?:claude-code|codex|gemini-cli|cursor|model:[a-z0-9][a-z0-9-]{0,47})$"
              }
            }
          ]
        },
        "routes": {
          "minItems": 1,
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "same_working_tree",
              "exact_commit",
              "authorised_patch"
            ]
          }
        }
      },
      "required": [
        "onLimit",
        "routes"
      ],
      "additionalProperties": false
    },
    "PayloadRefs": {
      "type": "object",
      "properties": {
        "builderVersion": {
          "type": "string",
          "minLength": 1,
          "maxLength": 64
        },
        "inputDigest": {
          "type": "string",
          "pattern": "^sha256:[0-9a-f]{64}$"
        },
        "sections": {
          "minItems": 1,
          "maxItems": 8,
          "type": "array",
          "items": {
            "$ref": "#/$defs/PayloadSectionRef"
          }
        }
      },
      "required": [
        "builderVersion",
        "inputDigest",
        "sections"
      ],
      "additionalProperties": false
    },
    "PayloadSectionRef": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "guardrails",
            "rules",
            "skills",
            "codemap",
            "memory",
            "task",
            "checkpoint"
          ]
        },
        "ref": {
          "type": "string",
          "pattern": "^overlane:\\/\\/payload\\/[A-Za-z0-9_-]+\\/[a-z]+$"
        },
        "digest": {
          "type": "string",
          "pattern": "^sha256:[0-9a-f]{64}$"
        },
        "tokens": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "stability": {
          "type": "string",
          "enum": [
            "project",
            "task",
            "turn"
          ]
        }
      },
      "required": [
        "id",
        "ref",
        "digest",
        "tokens",
        "stability"
      ],
      "additionalProperties": false
    }
  }
}

See exit codes for the status the process returns.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close

Overlane Agent

Ask about the docs. Answers are quoted from the pages, with links. This panel cannot change anything.

    Questions are answered in your browser from the docs index. Nothing you type here is stored or sent anywhere.