pixi install

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

--8<-- "docs/reference/cli/pixi/install_extender:description"

Usage

pixi install [OPTIONS]

Options

<a id="arg---environment" href="#arg---environment">--environment (-e) <ENVIRONMENT></a> : The environment to install

May be provided more than once.

<a id="arg---all" href="#arg---all">--all (-a)</a> : Install all environments
<a id="arg---skip" href="#arg---skip">--skip <SKIP></a> : 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.

<a id="arg---skip-with-deps" href="#arg---skip-with-deps">--skip-with-deps <SKIP_WITH_DEPS></a> : 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.

<a id="arg---only" href="#arg---only">--only <ONLY></a> : Install and build only these package(s) and their dependencies. Can be passed multiple times

May be provided more than once.

Config Options

<a id="arg---no-config" href="#arg---no-config">--no-config</a> : Don't read system or user-level configuration files. Project-local <project>/.pixi/config.toml is still loaded

env: PIXI_NO_CONFIG

default: false

<a id="arg---config-file" href="#arg---config-file">--config-file <PATH></a> : 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

<a id="arg---auth-file" href="#arg---auth-file">--auth-file <AUTH_FILE></a> : Path to the file containing the authentication token
<a id="arg---concurrent-downloads" href="#arg---concurrent-downloads">--concurrent-downloads <CONCURRENT_DOWNLOADS></a> : Max concurrent network requests, default is 50
<a id="arg---concurrent-solves" href="#arg---concurrent-solves">--concurrent-solves <CONCURRENT_SOLVES></a> : Max concurrent solves, default is the number of CPUs
<a id="arg---pinning-strategy" href="#arg---pinning-strategy">--pinning-strategy <PINNING_STRATEGY></a> : Set pinning strategy

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

<a id="arg---pypi-keyring-provider" href="#arg---pypi-keyring-provider">--pypi-keyring-provider <PYPI_KEYRING_PROVIDER></a> : Specifies whether to use the keyring to look up credentials for PyPI

options: disabled, subprocess

<a id="arg---run-post-link-scripts" href="#arg---run-post-link-scripts">--run-post-link-scripts</a> : Run post-link scripts (insecure)
<a id="arg---no-symbolic-links" href="#arg---no-symbolic-links">--no-symbolic-links</a> : Disallow symbolic links during package installation

env: PIXI_NO_SYMBOLIC_LINKS

<a id="arg---no-hard-links" href="#arg---no-hard-links">--no-hard-links</a> : Disallow hard links during package installation

env: PIXI_NO_HARD_LINKS

<a id="arg---no-ref-links" href="#arg---no-ref-links">--no-ref-links</a> : Disallow ref links (copy-on-write) during package installation

env: PIXI_NO_REF_LINKS

<a id="arg---tls-no-verify" href="#arg---tls-no-verify">--tls-no-verify</a> : Do not verify the TLS certificate of the server
<a id="arg---tls-root-certs" href="#arg---tls-root-certs">--tls-root-certs <TLS_ROOT_CERTS></a> : Which TLS root certificates to use: 'webpki' (bundled Mozilla roots) or 'system' (system store)

env: PIXI_TLS_ROOT_CERTS

<a id="arg---use-environment-activation-cache" href="#arg---use-environment-activation-cache">--use-environment-activation-cache</a> : Use environment activation cache (experimental)

Update Options

<a id="arg---frozen" href="#arg---frozen">--frozen</a> : 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

<a id="arg---locked" href="#arg---locked">--locked</a> : 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

<a id="arg---manifest-path" href="#arg---manifest-path">--manifest-path (-m) <MANIFEST_PATH></a> : The path to pixi.toml, pyproject.toml, or the workspace directory
<a id="arg---workspace" href="#arg---workspace">--workspace (-w) <WORKSPACE></a> : 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.

--8<-- "docs/reference/cli/pixi/install_extender:example"