Skip to main content
Version: v5.6.1

opschain workflows show

Included from Basic tier

opschain workflows show <project>/<code> [--definition]

Shows a stored server workflow's definition summary: the workflow address, id, name, summary (the resolved one-liner lists render), full description, draft and archived state, and the latest version number — as plain key: value lines, or as a machine document with -o json|yaml.

--definition prints the latest version's authored YAML definition instead of the summary, exactly as stored (a trailing newline is added when the stored text lacks one), ready to redirect to a file. workflows export wraps the same definition in the import envelope — reach for it when the file is for backup or re-import rather than reading.

This verb needs a server target (--server <url>, OPSCHAIN_SERVER, or the active context).

Flags​

FlagMeaning
--definitionPrint the latest version's YAML definition instead of the summary. Wins over -o — the definition prints verbatim.

Exit codes​

CodeMeaning
0Workflow shown.
1The command failed (workflow not found, server error).
2Usage error — malformed address, no server target.

Named errors​

  • expected <project>/<workflow-code>, got "<arg>" — the positional argument carries no slash (exit 2).
  • workflow "<code>" not found in project "<project>" — exit 1.

Examples​

opschain workflows show demo/nightly
opschain workflows show demo/nightly --definition > nightly.yaml

See also​

  • opschain docs cli/workflows-export — the same definition in the re-importable envelope.
  • opschain docs cli/workflows-list.