`flox config` command

NAME

flox-config - view and set configuration options

SYNOPSIS

flox [<general-options>] config
     [-l |
      -r |
      --set <key> <string> |
      --delete=<key>]

DESCRIPTION

Without any flags or when -l is passed, flox config shows all options with their computed value.

Config values are read from the following sources in order of descending priority:

Environment variables. All config options may be set by prefixing with FLOX_ and using SCREAMING_SNAKE_CASE. For example, disable_metrics may be set with FLOX_DISABLE_METRICS=true.
User customizations from $FLOX_CONFIG_DIR/flox.toml if set, otherwise flox/flox.toml in $XDG_CONFIG_HOME or any of $XDG_CONFIG_DIRS, wherever it is found first.
System settings from /etc/flox.toml or FLOX_SYSTEM_CONFIG_DIR/flox.toml.
flox provided defaults.

flox config commands that mutate configuration always write to the user config file determined in step 2.

Key Format

<key> supports dot-separated queries for nested values, for example:

flox config --set 'trusted_environments."owner/name"' trust

OPTIONS

Config Options

-l, --list
List the current values of all options.

-r, --reset
Reset all options to their default values without confirmation.

--set <key> <string>
Set <key> = <string> for a config key

--delete <key>
Delete config key

General Options

-h, --help
Prints help information.

The following options can be passed when running any flox subcommand but must be specified before the subcommand.

-v, --verbose
Increase logging verbosity. Invoke multiple times for increasing detail.

-q, --quiet
Silence logs except for errors.

SUPPORTED CONFIGURATION OPTIONS

config_dir
Directory where Flox should load its configuration file (default: $XDG_CONFIG_HOME/flox). This option will only take effect if set with $FLOX_CONFIG_DIR. config_dir is ignored.

cache_dir
Directory where Flox should store ephemeral data (default: $XDG_CACHE_HOME/flox).

data_dir
Directory where Flox should store persistent data (default: $XDG_DATA_HOME/flox).

disable_metrics
Disable collecting and sending usage metrics.

floxhub_token
Token to authenticate on FloxHub.

hide_default_prompt
Hide environments named ‘default’ from the shell prompt, and don’t add environments named ‘default’ to $FLOX_PROMPT_ENVIRONMENTS (default: true).

installer_channel
Release channel to use when checking for updates to Flox. Valid values are stable, nightly, or qa. (default: stable)

search_limit
How many items flox search should show by default.

set_prompt
Set shell prompt when activating an environment (default: true).

shell_prompt - DEPRECATED
Rule whether to change the shell prompt in activated environments (default: “show-all”). This has been deprecated in favor of set_prompt and hide_default_prompt. Possible values are * “show-all”: shows all active environments * “hide-all”: disables the modification of the shell prompt * “hide-default”: filters out environments named ‘default’ from the shell prompt

state_dir
Directory where Flox should store data that’s not critical but also shouldn’t be able to be freely deleted like data in the cache directory. (default: $XDG_STATE_HOME/flox e.g. ~/.local/state/flox)

trusted_environments
Remote environments that are trusted for activation. Contains keys of the form "<owner>/<name>" that map to either "trust" or "deny".

upgrade_notifications
Print notification if upgrades are available on flox activate. The notification message is:

Upgrades are available for packages in 'environment-name'.
Use 'flox upgrade --dry-run' for details.

(default: true)

ENVIRONMENT VARIABLES

$FLOX_DISABLE_METRICS
Variable for disabling the collection/sending of metrics data. If set to true, prevents Flox from submitting basic metrics information such as a unique token and the subcommand issued.

flox config command