Workspace

Configuration for a workspace in the Flow CLI. This configuration is used to define the settings for a workspace. Every workspace has a workspace config file named flow.yaml in the root of the workspace directory.

Properties

Properties:

Field	Description	Type	Default	Required
description	A description of the workspace. This description is rendered as markdown in the interactive UI.	string
descriptionFile	A path to a markdown file that contains the description of the workspace.	string
displayName	The display name of the workspace. This is used in the interactive UI.	string
envFiles	A list of environment variable files to load for the workspace. These files should contain key-value pairs of environment variables. By default, the .env file in the workspace root is loaded if it exists.	array (string)	[]
executables		ExecutableFilter
tags		CommonTags	[]
verbAliases		VerbAliases

Definitions

CommonTags

A list of tags. Tags can be used with list commands to filter returned data.

Type: array (string)

ExecutableFilter

Type: object

Properties:

Field	Description	Type	Default	Required
excluded	A list of directories or file patterns to exclude from the executable search. Supports directory paths (e.g., "node_modules/", "vendor/") and glob patterns for filenames (e.g., "*.js.flow", "temp"). Common exclusions like node_modules/, vendor/, third_party/, external/, and *.js.flow are excluded by default.	array (string)	[]
included	A list of directories or file patterns to include in the executable search. Supports directory paths (e.g., "src/", "scripts/") and glob patterns for filenames (e.g., ".test.flow", "example").	array (string)	[]

VerbAliases

A map of executable verbs to valid aliases. This allows you to use custom aliases for exec commands in the workspace. Setting this will override all of the default flow command aliases. The verbs and its mapped aliases must be valid flow verbs.

If set to an empty object, verb aliases will be disabled.

Type: map (string -> array (string))