Skip to main content
Version: v5.6.1

opschain workflows list

Included from Basic tier

opschain workflows list [--project <code>]

Lists workflow definitions. The target decides the source:

  • Locally (the default, or --local) it scans .opschain/workflows in the working tree with the same identity-header and duplicate-code rules running a workflow has, and prints each workflow's code, name, summary and file path, sorted by code.
  • Against a server (--server <url>, OPSCHAIN_SERVER, or the active context) it reads one project's stored workflows — --project is required there. A draft workflow's name is suffixed (draft), an archived one's (archived), and the FILE column is empty (stored workflows have no repository file).

Table columns: CODE, NAME, SUMMARY, FILE. SUMMARY is the resolved one-liner: the workflow's explicit summary: when it declares one, else the description's first sentence (else its first line), truncated with an ellipsis at 120 characters. opschain workflows show prints the full description. -o json|yaml prints the listing as a machine document instead.

Flags​

FlagMeaning
--project <code>The project code — required against a remote server, where the listing is that project's stored workflows. Ignored locally.
--filter <column>[!]=<value>Keep only rows matching the term (repeatable; terms AND). Columns are the printed table headers lowercased (spaces/dashes fold to _); * wildcards match the whole cell case-insensitively, != negates, commas mean any-of. Applied client-side. Grammar: opschain docs cli.

Exit codes​

CodeMeaning
0Listing printed (an empty listing is still success).
1The listing failed (server unreachable, project unknown, unreadable local catalog).
2Usage error.

Named errors​

  • listing workflows against a remote server reads one project's stored workflows: pass --project — a server target with no --project.

Examples​

opschain workflows list
opschain workflows list --project demo --server https://opschain.example.com

See also​

  • opschain docs cli/workflows-show — one stored workflow in full.
  • opschain docs cli/runs-create — running a listed workflow.
  • opschain learn 4.1.