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
| Field | Type | Default | Required | Description |
|---|---|---|---|---|
colorOverride | ColorPalette | Override the default color palette for the interactive UI. This can be used to customize the colors of the UI. | ||
currentNamespace | string | 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. | ||
currentVault | string | The name of the currently active vault. | ||
currentWorkspace | string | The name of the current workspace. This should match a key in the workspaces or remoteWorkspaces map. | ||
defaultLogMode | string | logfmt | 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. | |
defaultTimeout | string | 30m | The default timeout to use when running executables. This should be a valid duration string. | |
interactive | Interactive | |||
templates | map (string -> string) | map[] | A map of flowfile template names to their paths. | |
theme | string | default | The theme of the interactive UI. | |
updateCheck | boolean | false | Whether to check for CLI updates in the background. When enabled, flow will periodically check GitHub for a newer version and display a notice if one is available after each command. Set FLOW_NO_UPDATE_CHECK=1 to suppress checks regardless of this setting. | |
vaults | map (string -> string) | A legacy map of vault names to their storage paths, retained for backwards compatibility. The authoritative list of vaults is discovered from the vault configuration directory managed by flow; this map is no longer required to reference or switch vaults. | ||
workspaceMode | string | dynamic | 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. | |
workspaces | map (string -> string) | Yes | Map of workspace names to their paths. The path should be a valid absolute path to the workspace directory. |
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
| Field | Type | Default | Required | Description |
|---|---|---|---|---|
black | string | |||
body | string | |||
border | string | |||
codeStyle | string | The style of the code block. For example, monokai, dracula, github, etc. See chroma styles for available style names. | ||
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
| Field | Type | Default | Required | Description |
|---|---|---|---|---|
enabled | boolean | Yes | ||
notifyOnCompletion | boolean | Whether to send a desktop notification when a command completes. | ||
soundOnCompletion | boolean | Whether to play a sound when a command completes. |