Skip to content

oxo-flow resume#

Resume an interrupted workflow from a checkpoint file.

Usage#

oxo-flow resume [OPTIONS] <CHECKPOINT>

Description#

The resume command loads a checkpoint generated by a previous oxo-flow run and continues execution from where it left off. Rules that already completed successfully are skipped; only incomplete or previously-failed rules are re-executed.

The checkpoint file (.oxo-flow/checkpoint.json) is automatically created by oxo-flow run and stores the completion status and benchmarks of each rule, plus a config snapshot and per-rule fingerprints for change detection.

The checkpoint also records the working directory the original run executed in, so resume re-runs from the same place even when invoked from another directory — completed rules' outputs resolve identically and stay skipped. The recorded workflow path and workdir are stored as absolute paths; a legacy checkpoint without a recorded workdir falls back to the workflow file's directory.

Resuming goes through the same config-change impact analysis as run: if the workflow config or a rule definition changed since the checkpoint was written, only the affected rules and their downstream re-execute. See Config changes and precise invalidation. Input changes are detected the same way — glob, directory, and plain-file inputs are compared against the recorded manifests, and changed inputs re-execute the affected rules (see Input changes and manifest invalidation).

Options#

Option Description
-j, --jobs <JOBS> Number of parallel jobs (default: 1)
--ai-recover Enable AI error recovery on rule failure
--ai-max-retries <N> Maximum AI retries (overrides [ai] config)
--workdir <DIR> -d
--keep-going -k
--timeout <SECS> —
--no-report-snapshot —
--background —

Examples#

# Resume from the default checkpoint
oxo-flow resume .oxo-flow/checkpoint.json

# Resume with 4 parallel jobs
oxo-flow resume .oxo-flow/checkpoint.json -j 4

Notes#

  • The checkpoint stores a reference to the original workflow file path. If the workflow was moved or renamed, resume will fail with a clear error.
  • The recorded working directory is shown as Workdir: before execution. --workdir overrides it (e.g. when the project directory was moved).
  • oxo-flow run automatically resumes from the checkpoint if one exists. The standalone resume command is useful for explicitly re-running after inspecting the checkpoint state.
  • Use oxo-flow status to inspect the checkpoint before resuming.
  • --background detaches the resumed run (see run's Background runs section).

See Also#