overlane task checkpoint

Records a summary, the next action and the working-copy state for the held task. With –pause the task is paused for that reason and the lease is released. Nothing is committed or uploaded for you.

Usage

overlane task checkpoint --summary TEXT --next TEXT [--pause quota|handoff|user] [--dry-run]

Flags

Flag	Type	Required	Description
`--summary`	string	yes	What has been done so far
`--next`	string	yes	What to do next
`--pause`	one of `quota`, `handoff`, `user`	no	Pause the task for this reason and release the lease
`--dry-run`	boolean	no	Print the requests and file changes this command would make, then stop. Needs no credentials.

Examples

overlane task checkpoint --summary "Parser done" --next "Write the tests"
overlane task checkpoint --summary "Out of budget" --next "Resume" --pause quota

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 task checkpoint.

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": {
        "taskId": {
          "type": "string"
        },
        "commitSha": {
          "type": "string"
        },
        "route": {
          "type": "string"
        },
        "localOnly": {
          "type": "boolean"
        },
        "clean": {
          "type": "boolean"
        },
        "paused": {
          "type": [
            "string",
            "null"
          ]
        },
        "next": {
          "type": "string"
        }
      },
      "required": [
        "taskId",
        "commitSha",
        "route",
        "localOnly",
        "clean",
        "paused",
        "next"
      ],
      "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.