Stops the task and ends any lease on it. A cancelled task and its history stay on record. Use this, or archive, for a task that has a lease or recorded evidence and so cannot be deleted.
Usage
overlane task cancel [task-id] [--reason TEXT] [--dry-run] [--force]Arguments
| Argument | Required | Description |
|---|---|---|
task-id |
no | The task to cancel |
Flags
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--reason |
string | no | Why it is being cancelled | |
--dry-run |
boolean | no | Print the requests and file changes this command would make, then stop. Needs no credentials. | |
--force |
boolean | no | Confirm a destructive action when there is no terminal to ask on. Without it, exit 2. |
Examples
overlane task cancel task-7
overlane task cancel task-7 --reason "no longer needed"Behavior
- Effect:
destructive(deletes or reverts; needs--forcewithout a terminal). - Needs credentials: yes. Uses the network: yes.
- Supports
--dry-run: yes. Accepts--force: yes. - Machine-readable description:
overlane schema task cancel.
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": {
"task": {
"type": "object",
"properties": {
"taskId": {
"type": "string"
},
"outcome": {
"type": "string"
},
"state": {
"type": "string"
},
"pauseReason": {
"type": "string"
},
"version": {
"type": "number"
},
"lease": {
"type": "object",
"properties": {
"holder": {
"type": "string"
},
"expiresAt": {
"type": "string"
}
},
"required": [
"holder",
"expiresAt"
],
"additionalProperties": false
},
"acceptanceCriteria": {
"type": "array",
"items": {
"type": "string"
}
},
"requiredChecks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"minEvidenceLevel": {
"type": "string"
}
},
"required": [
"id",
"minEvidenceLevel"
],
"additionalProperties": false
}
},
"submitted": {
"type": "object",
"properties": {
"commitSha": {
"type": "string"
},
"submittedAt": {
"type": "string"
}
},
"required": [
"commitSha",
"submittedAt"
],
"additionalProperties": false
},
"evidenceCount": {
"type": "number"
},
"proof": {
"type": "string",
"enum": [
"proven",
"unproven"
]
},
"latestCheckpoint": {
"type": "object",
"properties": {
"createdAt": {
"type": "string"
},
"summary": {
"type": "string"
},
"nextAction": {
"type": "string"
},
"commitSha": {
"type": "string"
},
"workingTreeDigest": {
"type": "string"
},
"route": {
"type": "string"
},
"localOnly": {
"type": "boolean"
}
},
"required": [
"createdAt",
"summary",
"nextAction",
"commitSha",
"localOnly"
],
"additionalProperties": false
},
"archivedAt": {
"type": "string"
},
"restoreDaysLeft": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"taskId",
"outcome",
"state",
"version",
"acceptanceCriteria",
"requiredChecks",
"evidenceCount"
],
"additionalProperties": false
}
},
"required": [
"task"
],
"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.