Skip to main content

Documentation Index

Fetch the complete documentation index at: https://flox.dev/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
NAME

flox - developer environments you can take with you

​
SYNOPSIS

flox [<general options>] <command>
     [<command options>]
     [<args>] ...

​
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 for bash, fish and zsh. These completions are installed alongside Flox.

​
OPTIONS

​
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 Options

--version
Print flox version.

​
COMMANDS

Flox commands are grouped into categories pertaining to local development, sharing environments, and administration.

​
Local Development Commands

init
Create an environment in the current directory. activate
Enter the environment, type exit to leave. search
Search for system or library packages to install. show
Show details about a single package. install, i
Install packages into an environment. uninstall
Uninstall installed packages from an environment. edit
Edit the declarative environment configuration file. list, l
List packages installed in an environment. delete
Delete an environment.

​
Sharing Commands

push
Send an environment to FloxHub. pull
Pull an environment from FloxHub.

​
Additional Commands

update
Update an environment’s base catalog or update the global base catalog. upgrade
Upgrade packages in an environment. config
View and set configuration options. auth
FloxHub authentication commands.

​
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_MAX_PARALLEL_DOWNLOADS
Variable 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, $VISUAL
Override the default editor used for editing environment manifests and commit messages. $SSL_CERT_FILE, $NIX_SSL_CERT_FILE
If set, overrides the path to the default Flox provided SSL certificate bundle. Set NIX_SSL_CERT_FILE to only override packages built with Nix, and otherwise set SSL_CERT_FILE to override the value for all packages. See also: Nix environment variables - NIX_SSL_CERT_FILE

​
SEE ALSO

flox-init, flox-activate, 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