Skip to content

overlane claim readiness

Say whether this claim's branch is clear to merge as far as claims and the conflict check can tell

Updated View as MarkdownOpen in ChatGPTOpen in Claude

Combines the claim’s state and the recorded git merge-tree checks of its branch head against every other open branch. Not ready (exit 5) when the claim is queued, a check is missing for the current heads, a check failed or a conflict is recorded.

Usage

overlane claim readiness --claim ID

Flags

Flag Type Required Default Description
--claim string yes The claim to evaluate

Examples

overlane claim readiness --claim clm_abc123

Behavior

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

Result

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

{
  "type": "object",
  "properties": {
    "tenantId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
      "description": "tenant identifier"
    },
    "projectId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
      "description": "project identifier"
    },
    "claimId": {
      "type": "string"
    },
    "ready": {
      "type": "boolean"
    },
    "blockers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "enum": [
              "claim_queued",
              "claim_inactive",
              "conflict",
              "check_required",
              "check_error",
              "no_branch"
            ]
          },
          "message": {
            "type": "string",
            "minLength": 1
          },
          "with": {
            "type": "string"
          },
          "files": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "path": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 1000
                },
                "kind": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 80
                }
              },
              "required": [
                "path",
                "kind"
              ],
              "additionalProperties": false
            }
          },
          "nextCommand": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "code",
          "message",
          "nextCommand"
        ],
        "additionalProperties": false
      }
    },
    "checkedPairs": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "tenantId",
    "projectId",
    "claimId",
    "ready",
    "blockers",
    "checkedPairs"
  ],
  "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.