Flows

A flow is represented as a tab within the editor workspace and is the main way to organise nodes.

Flow tabs

Flow tabs

Note : The term "flow" is also used to informally describe a single set of connected nodes. So a flow (tab) can contain multiple flows (sets of connected nodes).

Each flow can have a name, and description that is displayed in the Information sidebar.

All of the nodes in a flow can access the same flow-scoped context.

Adding a flow

To add a new flow, either click the button in the top bar, or double-click on free space in the tab bar.

Reference
Key shortcutnone
Menu optionFlows -> Add
Actioncore:add-flow

Reordering flows

Flows can be reordered in the workspace by dragging their tabs around in the tab bar.

Editing flow properties

Flow properties editor

Flow properties editor

Information Sidebar

Information Sidebar

To edit a flow’s properties, double-click on its tab in the top bar. This will open the Flow Properties dialog.

Reference
Key shortcutnone
Menu optionFlows -> Rename
Actioncore:edit-flow

Within the dialog, the flow’s name and description can be set. The description can use Markdown syntax for formatting and will appear in the Information sidebar.

Enabling or disabling a flow

The flow can be enabled or disabled using the toggle button at the bottom of the dialog. If a flow is disabled, none of the nodes it contains will be created when the flow is deployed.

Since Node-RED 1.1.0

The button in the Information sidebar can also be used to enable or disable the node/flow.

Reference
Key shortcutnone
Menu optionnone
Actioncore:enable-flow
Reference
Key shortcutnone
Menu optionnone
Actioncore:disable-flow


Deleting a flow

To delete a flow, click the ‘Delete’ button in the Flow Properties dialog.

Reference
Key shortcutnone
Menu optionFlows -> Delete
Actioncore:remove-flow
Search flows

Search flows

Switching between flows

To open a list of the available flows, click the button in the top bar.

Reference
Key shortcutCtrl/⌘-Shift-f
Menu optionnone
Actioncore:list-flows
Reference
Key shortcutCtrl/⌘-Shift-j
Menu optionnone
Actioncore:show-previous-tab
Reference
Key shortcutCtrl/⌘-Shift-k
Menu optionnone
Actioncore:show-next-tab