Skip to content

flox init command


flox-init - initialize a Flox environment


flox [<general-options>] init
     [-n <name>]
     [-d <path>]


Create a new empty environment in the current directory.

The name of the environment will be the basename of the current directory or default if the current directory is $HOME. The --name flag can be used to give the environment a specific name.

By default the environment will be created in the current directory. Flox will add a directory $PWD/.flox containing all relevant environment metadata. The --dir flag can be used to create an environment in another location.

If an environment already exists in the current directory, or the path specified using --dir exists, an error is returned.

init will try to detect languages being used in the containing directory, and it will prompt with suggestions for packages or activation scripts to be added to the environment. These suggestions can be taken without prompting by passing --auto-setup. The suggestions can be accepted but then edited using flox edit. Currently, suggestions are made for Python and Nodejs.


Init Options

-n <name>, --name <name>
What to name the new environment (default: current directory).

-d <path>, --dir <path>
Directory to create the environment in (default: current directory).

Apply Flox recommendations for the environment based on what languages are being used in the containing directory.

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.


flox-activate(1), flox-install(1),