Config
User Configuration for the Flow CLI. Includes configurations for workspaces, templates, I/O, and other settings for the CLI.
It is read from the user's flow config directory:
- MacOS:
$HOME/Library/Application Support/flow - Linux:
$HOME/.config/flow - Windows:
%APPDATA%\flow
Alternatively, a custom path can be set using the FLOW_CONFIG_PATH environment variable.
Properties
Required:
workspacescurrentWorkspace
Properties:
| Field | Description | Type | Default | Required |
|---|---|---|---|---|
colorOverride | Override the default color palette for the interactive UI. This can be used to customize the colors of the UI. | ColorPalette | ||
currentNamespace | The name of the current namespace. Namespaces are used to reference executables in the CLI using the format workspace:namespace/name. If the namespace is not set, only executables defined without a namespace will be discovered. | string | ||
currentVault | The name of the current vault. This should match a key in the vaults map. | string | ||
currentWorkspace | The name of the current workspace. This should match a key in the workspaces or remoteWorkspaces map. | string | ||
defaultLogMode | The default log mode to use when running executables. This can either be hidden, json, logfmt or text hidden will not display any logs. json will display logs in JSON format. logfmt will display logs with a log level, timestamp, and message. text will just display the log message. | string | logfmt | |
defaultTimeout | The default timeout to use when running executables. This should be a valid duration string. | string | 30m | |
interactive | Interactive | |||
templates | A map of flowfile template names to their paths. | map (string -> string) | map[] | |
theme | The theme of the interactive UI. | string | default | |
vaults | A map of vault names to their paths. The path should be a valid absolute path to the vault file created by flow. | map (string -> string) | ||
workspaceMode | The mode of the workspace. This can be either fixed or dynamic. In fixed mode, the current workspace used at runtime is always the one set in the currentWorkspace config field. In dynamic mode, the current workspace used at runtime is determined by the current directory. If the current directory is within a workspace, that workspace is used. | string | dynamic | |
workspaces | Map of workspace names to their paths. The path should be a valid absolute path to the workspace directory. | map (string -> string) |
Definitions
ColorPalette
The color palette for the interactive UI. The colors can be either an ANSI 16, ANSI 256, or TrueColor (hex) value. If unset, the default color for the current theme will be used.
Type: object
Properties:
| Field | Description | Type | Default | Required |
|---|---|---|---|---|
black | string | |||
body | string | |||
border | string | |||
codeStyle | The style of the code block. For example, monokai, dracula, github, etc. See chroma styles for available style names. | string | ||
emphasis | string | |||
error | string | |||
gray | string | |||
info | string | |||
primary | string | |||
secondary | string | |||
success | string | |||
tertiary | string | |||
warning | string | |||
white | string |
Interactive
Configurations for the interactive UI.
Type: object
Properties:
| Field | Description | Type | Default | Required |
|---|---|---|---|---|
enabled | boolean | ✘ | ||
notifyOnCompletion | Whether to send a desktop notification when a command completes. | boolean | ||
soundOnCompletion | Whether to play a sound when a command completes. | boolean |