Skip to content

flox config command


flox-config - configure user parameters


flox [ <general-options> ] config ([(-l|--list)] | (-r|--reset) | –set <key> <value> | –set-number <key> <number> | –set-bool <key> <bool> | –delete <key>)


Configure and/or display user-specific parameters.

Without any flags or -l or --list shows all configurable options with their computed value.

Key Format

<key> supports dot-separated queries for nested vaules, e.g.

flox config --set 'nix.access_tokens.""' "ghp_xxx"`

Config Format

All config keys can be listed with

flox config

The dispalyed values are resolved by reading:

  1. package defaults from $PREFIX/etc/flox.toml
  2. installation defaults from /etc/flox.toml
  3. user customizations from $HOME/.config/flox/flox.toml
  4. environment variables

where the last occurence is used as the final value.

flox config commands that mutate configurations always write to $HOME/.config/flox/flox.toml.


General Options

Many flox commands wrap Nix commands of the same name, and will correspondingly pass on options and arguments directly to the underlying nix invocation. For more information on the options supported by specific Nix commands please invoke flox nix <command> help.

The following options are used specifically by flox and must be specified before the <command> argument.

-v, --verbose
Verbose mode. Invoke multiple times for increasing detail.

Debug mode. Invoke multiple times for increasing detail.

-V, --version
Print flox version.

Print flox installation prefix / Nix store path. (flox internal use only.)

Force execution in flox-bash (flox internal use only.)

Development Options

The following options are supported by all Development Commands:

[(-A|--attr) <package>]
Selects package (aka “attrPath”) to be used. If not provided flox will prompt for you to select from the list of known packages.

[--stability <stability>]
Selects the set of nixpkgs to be used as a basis

Config Options

[ (--list|-l) ]
List the current values of all configurable parameters.

[ (--reset|-r) ] : Reset all configurable parameters to their default values without further confirmation.

[ --set <key> <value> ] : Set <key> = <value> for string values

[ --set-number <key> <value> ] : Set <key> = <value> for number values

[ --set-bool <key> <value> ] : Set <key> = <value> for boolean values

[ --delete <key> ] : Reset the value for <key> to its default