Flow Grouping

Use breyta flows update to manage mutable flow metadata for grouped flows, including groupKey, groupName, groupDescription, and explicit groupOrder.

Quick Answer

Use this loop when related flows should render in a deliberate sequence:

Inspect current grouping metadata with breyta flows list --pretty or breyta flows show <slug> --pretty
Set or change grouping metadata with breyta flows update <slug> ...
Verify sibling order with breyta flows show <slug> --pretty

Use breyta help flows update for exact flag truth.

What Lives In Group Metadata

Flow grouping is mutable workspace metadata. It does not round-trip through breyta flows pull / breyta flows push source files.

That means:

use the pulled .clj file for authored flow logic
use breyta flows update for grouping changes
verify grouped siblings through flows list --pretty / flows show --pretty

Set Or Update A Group

Create or update grouping metadata on a flow:

breyta flows update invoice-start \
  --group-key invoice-pipeline \
  --group-name "Invoice Pipeline" \
  --group-description "Flows that run in sequence for invoice processing"

Rules:

groupName is required whenever groupKey is set
groupKey is the stable identifier for the group
groupDescription is optional, but use one shared description across siblings when possible

Set Explicit Group Order

Use groupOrder when grouped flows should render in execution order:

breyta flows update invoice-start --group-order 10
breyta flows update invoice-validate --group-order 20
breyta flows update invoice-approve --group-order 30

Ordering rules:

lower groupOrder values sort first
use spaced values like 10, 20, 30 so future insertions are easy
flows show <slug> --pretty returns sibling groupFlows ordered by explicit groupOrder when present

Verify Grouping

Use these read paths after any grouping change:

breyta flows list --pretty
breyta flows show invoice-start --pretty
breyta help flows update

Look for:

groupKey
groupName
groupDescription
groupOrder
groupFlows

Clear Order Or Clear The Whole Group

Clear only the explicit order:

breyta flows update invoice-approve --group-order ""

Clear the entire group membership from a flow:

breyta flows update invoice-approve --group-key ""