Updates the fields you pass; each change is an audit event. Status cannot be set to done: an issue closes when its task is verified by evidence. Changing priority re-ranks the active task in the task queue. Given a task ID whose task has no issue yet, it opens one titled from the task first.
Usage
overlane issue update issue-id [--title TEXT] [--description TEXT] [--status backlog|todo|in_progress|in_review|cancelled] [--priority P0|P1|P2|P3] [--estimate N] [--label LABEL_ID...] [--cycle CYCLE_ID] [--work-project WORK_PROJECT_ID] [--pr OWNER/REPO#N...] [--dry-run]Arguments
| Argument | Required | Description |
|---|---|---|
issue-id |
yes | The issue ID, or the ID of the task it holds (task-…) |
Flags
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--title |
string | no | New title | |
--description |
string | no | New description | |
--status |
one of backlog, todo, in_progress, in_review, cancelled |
no | New status (never done) | |
--priority |
one of P0, P1, P2, P3 |
no | New priority | |
--estimate |
string | no | New estimate in points | |
--label |
string (repeatable) | no | A label ID from overlane issue label list; repeat for more. Replaces the issue’s labels; none clears them |
|
--cycle |
string | no | A cycle ID from overlane issue cycle list; none takes the issue out of its cycle |
|
--work-project |
string | no | A work project ID from overlane issue project list; none takes the issue out of its work project |
|
--pr |
string (repeatable) | no | A pull request to link, such as acme/app#12; repeat for more. Replaces the linked list | |
--dry-run |
boolean | no | Print the requests and file changes this command would make, then stop. Needs no credentials. |
Examples
overlane issue update iss_ab12cd34ef56gh78 --priority P0
overlane issue update iss_ab12cd34ef56gh78 --status in_progress --title "New title"
overlane issue update task-ab12cd34ef56 --pr acme/app#12Behavior
- 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 issue update.
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": {
"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"
},
"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)))$"
},
"updatedAt": {
"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)))$"
},
"archivedAt": {
"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)))$"
},
"deletedAt": {
"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)))$"
},
"issueId": {
"type": "string",
"pattern": "^iss_[A-Za-z0-9]{8,32}$",
"description": "issue identifier"
},
"number": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"description": {
"type": "string",
"maxLength": 20000
},
"status": {
"type": "string",
"enum": [
"backlog",
"todo",
"in_progress",
"in_review",
"done",
"cancelled"
]
},
"priority": {
"type": "string",
"enum": [
"P0",
"P1",
"P2",
"P3"
]
},
"rank": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"assignee": {
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "human"
},
"userId": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
},
"required": [
"type",
"userId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "agent"
},
"executor": {
"type": "string",
"enum": [
"claude-code",
"codex"
]
}
},
"required": [
"type",
"executor"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "bot"
},
"botId": {
"type": "string",
"pattern": "^bot_[A-Za-z0-9]{8,32}$"
}
},
"required": [
"type",
"botId"
],
"additionalProperties": false
}
]
},
{
"type": "null"
}
]
},
"assignedBy": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"human",
"agent",
"bot",
"sync",
"import",
"system"
]
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"type",
"id"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"externalAssignee": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"labelIds": {
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"pattern": "^lbl_[A-Za-z0-9]{8,32}$",
"description": "label identifier"
}
},
"workProjectId": {
"anyOf": [
{
"type": "string",
"pattern": "^wpr_[A-Za-z0-9]{8,32}$",
"description": "work project identifier"
},
{
"type": "null"
}
]
},
"cycleId": {
"anyOf": [
{
"type": "string",
"pattern": "^cyc_[A-Za-z0-9]{8,32}$",
"description": "cycle identifier"
},
{
"type": "null"
}
]
},
"estimate": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 1000
},
{
"type": "null"
}
]
},
"links": {
"type": "object",
"properties": {
"tasks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"taskId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
"description": "task identifier"
},
"state": {
"type": "string",
"enum": [
"active",
"closed"
]
},
"linkedAt": {
"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)))$"
},
"assignedBy": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"human",
"agent",
"bot",
"sync",
"import",
"system"
]
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"type",
"id"
],
"additionalProperties": false
}
},
"required": [
"taskId",
"state",
"linkedAt",
"assignedBy"
],
"additionalProperties": false
}
},
"pullRequests": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\w.-]+\\/[\\w.-]+#\\d+$"
}
},
"runs": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
}
},
"required": [
"tasks",
"pullRequests",
"runs"
],
"additionalProperties": false
},
"external": {
"anyOf": [
{
"type": "object",
"properties": {
"source": {
"type": "string",
"enum": [
"overlane",
"github",
"linear",
"jira",
"github_projects",
"tasks_md"
]
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"url": {
"type": "string",
"maxLength": 500,
"format": "uri"
}
},
"required": [
"source",
"id"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"createdBy": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"human",
"agent",
"bot",
"sync",
"import",
"system"
]
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"type",
"id"
],
"additionalProperties": false
}
},
"required": [
"tenantId",
"projectId",
"createdAt",
"updatedAt",
"issueId",
"number",
"title",
"description",
"status",
"priority",
"rank",
"assignee",
"assignedBy",
"externalAssignee",
"labelIds",
"workProjectId",
"cycleId",
"estimate",
"links",
"external",
"createdBy"
],
"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.