`flox pull` command

NAME

flox-pull - pull environment from FloxHub

SYNOPSIS

flox [<general-options>] pull
     [-d=<path>]
     [-r=<owner>/<name> | <owner>/<name> | [-f]]
     [-f]
     [-c]

DESCRIPTION

Pull an environment from FloxHub and create a local reference to it, or, if an environment has already been pulled, retrieve any updates.

When pulling an environment for the first time, -d specifies the directory in which to create that environment. The remote environment is specified in the form <owner>/<name>. It may optionally be preceded by -r, but -r is not necessary and is accepted simply for consistency with other environment commands.

When pulling an environment that has already been pulled, -d specifies which environment to sync. If -d is not specified and the current directory contains an environment, that environment is synced. -f may be specified in this case, forcibly updating the environment locally even if there are local changes not reflected in the remote environment. <owner>/<name> may be specified in this case and will replace the environment with the specified environment.

A remote environment may not support the architecture or operating system of the local system pulling the environment, in which case -f may be passed to forcibly add the current system to the environment’s manifest. This may create a broken environment that cannot be pushed back to FloxHub until it is repaired with flox-edit(1). See manifest.toml(5) for more on multi-system environments.

OPTIONS

Pull Options

-d, --dir
Directory to pull an environment into, or directory that contains an environment that has already been pulled (default: current directory).

-r <owner>/<name>, --remote <owner>/<name>
ID of the environment to pull.

<owner>/<name>
ID of the environment to pull.

-f, --force
Forcefully overwrite the local copy of the environment, and accept any kind of modification and possibly incompatible results that have to be addressed manually.

-c, --copy
Create a local copy of an environment by removing the connection to the upstream environment on FloxHub. When pulling a new environment this creates a new environment that can be used locally or pushed to FloxHub under a new user or name.

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 pull command