DOC_INDEX
THEME
DOCS/Specification/Step Flags

Step Flags

The per-step flags list - log_result, log_outputs, log_context, and breakpoint

flags: is a list of opt-in switches on a step, separate from what the step does. Three control extra logging; one (breakpoint) is an interactive pause.

- name: compile
  func: shell
  do: "make build"
  flags: [log_result, log_outputs]

Logging flags

By default a step prints its command and a status marker; these add detail for the steps you care about.

FlagEffect
log_resultPrint the step's raw result (command output / response)
log_outputsPrint the values extracted by the step's outputs: block
log_contextPrint the variable/env context the step ran with

Supported on shell, http, task calls, and module calls. An unknown flag, or a logging flag on a function that doesn't support it, is a load-time error listing the valid flags. Conditional steps (if: / switch:) don't take flags:.

breakpoint

flags: [breakpoint] pauses before the step runs, in an interactive terminal, and opens a read-only inspector (live vars / env / step outputs / evaluate an expression). Valid on any function step.

      - name: ship
        func: shell
        flags: [breakpoint]       # stop here and inspect before deploying
        do: "deploy {{ steps.build.image }}"

You can also set a breakpoint without editing the file, with the repeatable --break-before <step> run flag — --break-before deploy.ship targets one task's step; a bare name matches any:

orchstep run deploy --break-before ship          # any step named "ship"
orchstep run deploy --break-before deploy.ship   # only deploy's "ship"

The breakpoint is read-only (it never changes state) and a no-op in a non-TTY context (CI, pipelines), during --dry-run, or when ORCHSTEP_SKIP_BREAKPOINT is set — so it never hangs an unattended run. Full details, the inspector commands, and a screencast are in the CLI reference → Interactive breakpoints.

Quick reference

FlagEffectWhere it applies
log_resultprint the raw resultshell, http, task/module calls
log_outputsprint extracted outputs:shell, http, task/module calls
log_contextprint the vars/env contextshell, http, task/module calls
breakpointpause before the step (interactive, read-only)any function step