Skip to content

flox edit command

NAME

flox-edit - edit declarative format of an environment

SYNOPSIS

flox [ <general-options> ] edit [ <options> ]

DESCRIPTION

Edit environment declaratively. Has the effect of creating the environment if it does not exist.

OPTIONS

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
Debug mode. Invoke multiple times for increasing detail.

-V, --version
Print flox version.

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

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

Environment Options

The following option is supported by environment commands:

(-e|–environment) <name>
Selects flox environment to be modified or used. If not provided then flox will fall back to using the default environment.

Edit Options

[ (--file|-f) <file> ]
Replace environment declaration with that in <file>. If <file> is -, reads from stdin.