Skip to content

Flows

  • Flow object

    • description string | null ○ Optional description of this flow, shown in synth list.
    • nodes object (Default: {}) ○ Mapping of IDs to nodes.
    • args object (Default: {}) ○ Template arguments to apply to all nodes in this flow.
    • envs object (Default: {}) ○ Environment variables to apply to all nodes in this flow.

  • Node object

    • recipe Recipe | string ○ The recipe to run for this node. It may either be the name of a pre-defined recipe, or a full recipe definition.
    • args object (Default: {}) ○ Template arguments to apply to this node.
    • envs object (Default: {}) ○ Environment variables to apply to this node.
    • triggers array[Once | After | Restart | Watch | string] ○ The list of triggers for this node. Each trigger may be the name of a pre-defined trigger, or a full trigger definition.
    • color string (Default: None) ○ The color that will be used to help differentiate this node from others.