overlane run pause | Overlane Docs

Sets the project’s run policy to paused. Every run then stops at its next check (STOP paused). Undo with overlane run resume. Safe to repeat.

Usage

overlane run pause [--dry-run]

Flags

Flag	Type	Required	Default	Description
`--dry-run`	boolean	no		Print the requests and file changes this command would make, then stop. Needs no credentials.

Examples

overlane run pause
overlane run pause --dry-run

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 run pause.

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": {
        "changed": {
          "type": "boolean"
        },
        "policy": {
          "type": "object",
          "properties": {
            "status": {
              "type": "string",
              "enum": [
                "active",
                "paused"
              ]
            },
            "buildAheadLimit": {
              "type": "string"
            },
            "maxTasksPerRun": {
              "type": "number"
            },
            "maxMinutesPerRun": {
              "type": "number"
            },
            "usagePolicy": {
              "type": "object",
              "properties": {
                "order": {
                  "default": "sequential",
                  "type": "string",
                  "enum": [
                    "sequential",
                    "round_robin",
                    "parallel"
                  ]
                },
                "maxParallel": {
                  "default": 1,
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 9007199254740991
                },
                "pace": {
                  "default": "asap",
                  "type": "string",
                  "enum": [
                    "asap",
                    "steady"
                  ]
                },
                "capPercent": {
                  "default": 85,
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 100
                },
                "reservePercent": {
                  "default": 0,
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 99
                },
                "iterationsPerWindow": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 9007199254740991
                }
              },
              "required": [
                "order",
                "maxParallel",
                "pace",
                "capPercent",
                "reservePercent"
              ],
              "additionalProperties": false
            },
            "executorsAllowed": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "handoffOnLimit": {
              "anyOf": [
                {
                  "type": "string",
                  "const": "pause"
                },
                {
                  "minItems": 1,
                  "type": "array",
                  "items": {
                    "anyOf": [
                      {
                        "type": "string",
                        "enum": [
                          "claude-code",
                          "codex",
                          "gemini-cli",
                          "cursor"
                        ]
                      },
                      {}
                    ]
                  }
                }
              ]
            }
          },
          "required": [
            "status",
            "buildAheadLimit",
            "maxTasksPerRun",
            "maxMinutesPerRun",
            "usagePolicy",
            "executorsAllowed",
            "handoffOnLimit"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "changed",
        "policy"
      ],
      "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.