NAME
flox - developer environments you can take with youSYNOPSIS
DESCRIPTION
Flox is a virtual environment and package manager all in one. With Flox you create environments that layer and provide dependencies just where it matters, making them portable across the full software lifecycle.Command Line Completions
Flox ships with command line completions forbash, fish and zsh.
These completions are installed alongside Flox.
OPTIONS
General Options
-h, --helpPrints help information. The following options can be passed when running any
flox subcommand
but must be specified before the subcommand.
-v, --verboseIncrease logging verbosity. Invoke multiple times for increasing detail.
-q, --quietSilence logs except for errors.
Flox Options
--versionflox version.
COMMANDS
Flox commands are grouped into categories pertaining to local development, sharing environments, and administration.Local Development Commands
initCreate an environment in the current directory.
activateEnter the environment, run
flox deactivate to leave.
developEnter a development shell for a Nix expression build.
deactivateDeactivate the current environment.
runRun a command from a Flox Catalog package without installing it.
searchSearch for system or library packages to install.
showShow details about a single package.
install, iInstall packages into an environment.
uninstallUninstall installed packages from an environment.
editEdit the declarative environment configuration file.
list, lList packages installed in an environment.
deleteDelete an environment.
Sharing Commands
pushSend an environment to FloxHub.
pullPull an environment from FloxHub.
Additional Commands
updateUpdate an environment’s base catalog or update the global base catalog.
upgradeUpgrade packages in an environment.
configView and set configuration options.
authFloxHub authentication commands.
ENVIRONMENT VARIABLES
$FLOX_DISABLE_METRICSVariable 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_MAX_PARALLEL_DOWNLOADSVariable for controlling parallel downloads when building an environment. By default, every package for an environment is downloaded in parallel, but on poor connections this can cause packages to download slower and in some cases time out. Setting this to a number greater than or equal to 1 will limit the number of active downloads to the specified number.
$EDITOR, $VISUALOverride the default editor used for editing environment manifests and commit messages.
$SSL_CERT_FILE, $NIX_SSL_CERT_FILECertificate bundles for TLS.
SSL_CERT_FILE is the system-wide setting
that every program honors, and Flox never sets it. NIX_SSL_CERT_FILE
is read by Nix and by Nix-built software (ahead of SSL_CERT_FILE); set
it to give those a bundle of their own, for example when SSL_CERT_FILE
is in a format they cannot read. If neither is set, Flox sets
NIX_SSL_CERT_FILE to the bundle it ships, for Nix software alone, and
exports it into activated environments. Once an activation has applied
that default, an SSL_CERT_FILE exported later in the shell does not
reach Nix-built software; set NIX_SSL_CERT_FILE as well. For Nix
itself, an ssl-cert-file setting in nix.conf outranks both
variables. Flox does not pass SSL_CERT_DIR on to Nix-built software
either; an environment that needs a directory of certificates can export
it from [vars].
See also: Nix environment variables -
NIX_SSL_CERT_FILE
$LOCALE_ARCHIVE (Linux), $PATH_LOCALE (macOS)Locale data for Nix-built software, which does not find the system’s own. If unset, Flox sets the variable to the locale data it ships and exports it into activated environments. A value you set is left alone.
SEE ALSO
flox-init,
flox-activate,
flox-develop, flox-run,
flox-install,
flox-uninstall,
flox-upgrade,
flox-search, flox-show,
flox-edit,
manifest.toml,
flox-list, flox-auth,
flox-push, flox-pull,
flox-delete,
flox-config