overlane task new | Overlane Docs

The quick way to get an active task, which every change needs. Creates a task with the title as its outcome (one default criterion and every path unless you pass –criterion and –path), claims it, and ranks it (default P1). With –unclaimed it only creates and ranks the task, leaving it ready for the loop. Without –unclaimed it fails with exit 5 if this working copy already holds a task.

Usage

overlane task new title... [--priority P0|P1|P2|P3] [--top] [--criterion TEXT...] [--path GLOB...] [--check ID:LEVEL...] [--unclaimed] [--dry-run]

Arguments

Argument	Required	Description
`title...`	yes	What the task must achieve

Flags

Flag	Type	Required	Default	Description
`--priority`	one of `P0`, `P1`, `P2`, `P3`	no	`P1`	P0 is most urgent, P3 least
`--top`	boolean	no		Put the task first within its priority
`--criterion`	string (repeatable)	no		An acceptance criterion; repeat for more (default: the title)
`--path`	string (repeatable)	no		A file pattern the task may change (default: everything)
`--check`	string (repeatable)	no		A required check and its minimum evidence level, for example unit_tests:L2
`--unclaimed`	boolean	no		Create the task ready in the queue without claiming it, for a follow-up or a filed failure another agent will take
`--dry-run`	boolean	no		Print the requests and file changes this command would make, then stop. Needs no credentials.

Examples

overlane task new "Fix login redirect"
overlane task new "Follow up: tidy the parser" --unclaimed
overlane task new "Hotfix the build" --priority P0 --top

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 new.

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"
        },
        "version": {
          "type": "number"
        },
        "state": {
          "type": "string"
        },
        "holder": {
          "type": "string"
        },
        "priority": {
          "type": "string",
          "enum": [
            "P0",
            "P1",
            "P2",
            "P3"
          ]
        },
        "rank": {
          "type": "number"
        },
        "issueId": {
          "type": [
            "string",
            "null"
          ]
        },
        "next": {
          "type": "string"
        },
        "payload": {
          "type": "object",
          "properties": {
            "file": {
              "type": "string"
            },
            "totalTokens": {
              "type": "number"
            },
            "sections": {
              "type": "object",
              "propertyNames": {
                "type": "string"
              },
              "additionalProperties": {
                "type": "string"
              }
            }
          },
          "required": [
            "file",
            "totalTokens",
            "sections"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "taskId",
        "version",
        "state",
        "holder",
        "priority",
        "rank",
        "issueId",
        "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.