Skip to content
Shipper

shipper_clear_auto_ship_halt

shipper_clear_auto_ship_halt

Section titled “shipper_clear_auto_ship_halt”

Clear the active repository’s persistent auto-ship halt in one atomic write. A halt is an operator-requested repository hold that survives idle periods, safe-checkpoint wind-down, restarts, and disabling or enabling auto-ship; only an explicit clear ends it. This does not enable auto-ship, change worker count, resume an engaged safety stop, restart stopped runs, restore withdrawn queue entries, or start or attach to a daemon. Use shipper_resume_auto_ship for the separate automatic safety stop.

When to use

Section titled “When to use”

Use this state-changing local operation to release the active repository’s persistent auto-ship halt. A halt is an operator-requested repository hold that preserves enablement and worker settings and survives idle periods, safe-checkpoint wind-down, and daemon, Desktop, CLI, or machine restarts; only an explicit clear ends it. The target is the canonical identity of the repository selected at server startup or by shipper_switch_repo. It performs exactly one atomic core desired-state write of { haltRequested: false }, does not pre-read state, register a checkout, start or attach to a daemon, alter enablement or worker count, or resume an engaged safety stop. It returns status: recorded with outcome: "cleared" after a change and outcome: "already-clear" as an explicit no-op. A future schema or valid foreign identity returns the successful protocol result status: refused with only repository and conflict, leaving the retained record unchanged. Clearing releases repository-control checkpoint Stops a supervisor has not yet consumed; it never restarts already-stopped runs, restores withdrawn queue entries, or replays prior work, and it claims no observed retraction. Clearing a halt does not enable auto-ship. Use shipper_resume_auto_ship for the separate automatic safety stop, and the generic shipper_set_auto_ship when an atomic combined enable-and-clear is needed.

Behavior hints

Section titled “Behavior hints”
  • readOnlyHint: false — The tool intentionally clears durable local repository halt state.
  • destructiveHint: false — The tool clears only the halt bit and does not delete repository or workflow artifacts, change enablement or workers, or revive stopped work.
  • idempotentHint: true — Repeated calls after the first clear succeed with outcome: "already-clear".
  • openWorldHint: false — The tool writes only local machine state and does not contact GitHub or another external system.

Input schema

Section titled “Input schema”
NameTypeRequiredDefaultDescription

Output schema

Section titled “Output schema”
NameTypeRequiredDefaultDescription
statusenum: recorded, refusedyes--
repositorystringyes--
outcomeenum: cleared, already-clearno--
resultingobject (auto-ship desired state)no--
previousobject (auto-ship desired state)no--
conflict-no--

Example call

Section titled “Example call”
{}

Example result

Section titled “Example result”
{
  "content": [{ "type": "text", "text": "Auto-ship halt cleared for repository owner/repo." }],
  "structuredContent": {
    "status": "recorded",
    "repository": "owner/repo",
    "outcome": "cleared",
    "previous": { "enabled": true, "workerCount": 2, "haltRequested": true },
    "resulting": { "enabled": true, "workerCount": 2, "haltRequested": false }
  }
}


No-op when no halt is recorded: { "status": "recorded", "repository": "owner/repo", "outcome": "already-clear", ... }, with text "No auto-ship halt was recorded for repository owner/repo; it was already clear."


Compatibility refusal: { "status": "refused", "repository": "owner/repo", "conflict": { "kind": "unsupported-schema-version", "recordPath": "<retained path>", "retainedSchemaVersion": 4, "currentSchemaVersion": 3, "readableSchemaVersions": [1, 2, 3], "staleSide": "client" } }. It contains no outcome, previous, or resulting fields and offers the current-client/install remedy, not a repair or discard gesture.

Error modes

Section titled “Error modes”
  • Canonical repository identity unavailable: Could not derive a canonical repository identity for .
  • Desired-state persistence failure: <underlying filesystem, lock, or atomic-write error>
Section titled “Related tools”