pixi install

Install an environment, both updating the lock file and installing the environment

Usage

pixi install [OPTIONS]

Options

• --environment (-e) <ENVIRONMENT>

  The environment to install
  May be provided more than once.

• --all (-a)

  Install all environments

• --skip <SKIP>

  Skip installation of specific packages present in the lock file. This uses a soft exclusion: the package will be skipped but its dependencies are installed
  May be provided more than once.

• --skip-with-deps <SKIP_WITH_DEPS>

  Skip a package and its entire dependency subtree. This performs a hard exclusion: the package and its dependencies are not installed unless reachable from another non-skipped root
  May be provided more than once.

• --only <ONLY>

  Install and build only these package(s) and their dependencies. Can be passed multiple times
  May be provided more than once.

Config Options

• --no-config

  Don't read system or user-level configuration files. Project-local <project>/.pixi/config.toml is still loaded
  env: PIXI_NO_CONFIG
  default: false

• --config-file <PATH>

  Load configuration from this file instead of searching system and user-level paths. Project-local <project>/.pixi/config.toml is still merged on top
  env: PIXI_CONFIG_FILE

• --auth-file <AUTH_FILE>

  Path to the file containing the authentication token

• --concurrent-downloads <CONCURRENT_DOWNLOADS>

  Max concurrent network requests, default is 50

• --concurrent-solves <CONCURRENT_SOLVES>

  Max concurrent solves, default is the number of CPUs

• --pinning-strategy <PINNING_STRATEGY>

  Set pinning strategy
  options: semver, minor, major, latest-up, exact-version, no-pin

• --pypi-keyring-provider <PYPI_KEYRING_PROVIDER>

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

• --run-post-link-scripts

  Run post-link scripts (insecure)

• --no-symbolic-links

  Disallow symbolic links during package installation
  env: PIXI_NO_SYMBOLIC_LINKS

• --no-hard-links

  Disallow hard links during package installation
  env: PIXI_NO_HARD_LINKS

• --no-ref-links

  Disallow ref links (copy-on-write) during package installation
  env: PIXI_NO_REF_LINKS

• --tls-no-verify

  Do not verify the TLS certificate of the server

• --tls-root-certs <TLS_ROOT_CERTS>

  Which TLS root certificates to use: 'webpki' (bundled Mozilla roots) or 'system' (system store)
  env: PIXI_TLS_ROOT_CERTS

• --use-environment-activation-cache

  Use environment activation cache (experimental)

Update Options

• --frozen

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

• --locked

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

Global Options

• --manifest-path (-m) <MANIFEST_PATH>

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

• --workspace (-w) <WORKSPACE>

  Name of the workspace

Description

Install an environment, both updating the lock file and installing the environment.

This command installs an environment, if the lock file 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 reinstall to reinstall all environments, one environment or just some packages of an environment.

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 lock file without updating the lock file.
4. This will install the environment from the lock file without updating the lock file and ensuring the environment is locked correctly.
5. This will install the lint environment.