Skip to main content
Version: v5.7.0

opschain run workflow

Included from Basic tier

opschain run workflow <code | file> [flags]

The workflow form of opschain run: exactly opschain runs create workflow <code> --local. The positional argument is the workflow CODE (resolved under .opschain/workflows) or a workflow FILE path, and --env names the target environment. The run executes attached and the process exit code is its outcome; the alias never targets a server (--server is refused by name, the active context is ignored).

Flags​

FlagMeaning
--env <code>Target environment code. Required.
--asset <code>Refused for workflows — each workflow step names its own target.
--ref <git-ref>Run a clean snapshot of this git ref instead of the working copy.
--planResolve and print the full nested step tree without running anything.
-i, --input k=vA typed run input (repeatable), validated against the workflow's inputs: declarations; a repeated key builds a list, a list<string> input also accepts a comma-separated value, and a secret input takes secret-vault://… or secret-env://<NAME>.
--skip-step <name>Workflow step name to skip (repeatable; an entry skips its whole subtree).
--starting-step <path>Skip every step before this step path; its ancestors pass through.
--approve-allAuto-answer wait and approval steps with their defaults.
--max-parallel <n>Maximum concurrently running steps (0 = engine default).
--keep-workspaceKeep step and run workspaces for debugging or artifact collection instead of cleaning up.
--follow-logs <path>Show log output for this step path (and its descendants) only.
--timeout <d>Override the run timeout (e.g. 30m, 2h; 0 = engine default).
--step-timeout <d>Override the default per-step timeout; a step's own timeout still wins.
--env-passthrough <names>Comma-separated extra environment variable names handed from the invoking process's environment to every step of every nested run, on top of the host executor's default allowlist (OPSCHAIN_VAULT_* names are dropped).

Exit codes and named errors are those of opschain docs cli/run.

Examples​

opschain run workflow nightly --env dev
opschain run workflow .opschain/workflows/release.yaml --env dev -i version=1.4.0

See also​

  • opschain docs cli/run — the change form and the alias rules.
  • opschain docs cli/runs-create-workflow — the full creation verb, both lanes.
  • opschain learn 4.1 — the guided workflow walkthrough.