pixi install

About

Install an environment, both updating the lockfile and installing the environment

Usage

pixi install [OPTIONS]

Config Options

• --tls-no-verify

  Do not verify the TLS certificate of the server

• --auth-file <AUTH_FILE>

  Path to the file containing the authentication token

• --pypi-keyring-provider <PYPI_KEYRING_PROVIDER>

  Specifies whether to use the keyring to look up credentials for PyPI
  options: disabled, subprocess

• --concurrent-solves <CONCURRENT_SOLVES>

  Max concurrent solves, default is the number of CPUs

• --concurrent-downloads <CONCURRENT_DOWNLOADS>

  Max concurrent network requests, default is 50

Update Options

• --frozen

  Install the environment as defined in the lockfile, doesn't update lockfile if it isn't up-to-date with the manifest file
  env: PIXI_FROZEN

• --locked

  Check if lockfile is up-to-date before installing the environment, aborts when lockfile isn't up-to-date with the manifest file
  env: PIXI_LOCKED

• --environment (-e) <ENVIRONMENT>

  The environment to install
  May be provided more than once.

• --all (-a)

  Install all environments

Global Options

• --manifest-path <MANIFEST_PATH>

  The path to pixi.toml, pyproject.toml, or the workspace directory

Description

Install an environment, both updating the lockfile and installing the environment.

This command installs an environment, if the lockfile is not up-to-date it will be updated.

pixi install only installs one environment at a time, if you have multiple environments you can select the right one with the --environment flag. If you don't provide an environment, the default environment will be installed.

If you want to install all environments, you can use the --all flag.

Running pixi install is not required before running other commands like pixi run or pixi shell. These commands will automatically install the environment if it is not already installed.

You can use pixi clean to remove the installed environments and start fresh.

Examples

pixi install  # (1)!
pixi install --manifest-path ~/myworkspace/pixi.toml # (2)!
pixi install --frozen # (3)!
pixi install --locked # (4)!
pixi install --environment lint # (5)!
pixi install -e lint # (5)!

1. This will install the default environment.
2. This will install the default environment from the manifest file at the given path.
3. This will install the environment from the lockfile without updating the lockfile.
4. This will install the environment from the lockfile without updating the lockfile and ensuring the environment is locked correctly.
5. This will install the lint environment.