pixi add

Adds dependencies to the workspace

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

Usage

pixi add [OPTIONS] <SPEC>...

Arguments

<a id="arg-<SPEC>" href="#arg-<SPEC>"><SPEC></a> : The dependency as names, conda MatchSpecs or PyPi requirements

May be provided more than once.

required: true

Options

<a id="arg---pypi" href="#arg---pypi">--pypi</a> : The specified dependencies are pypi dependencies. Conflicts with host and build
<a id="arg---platform" href="#arg---platform">--platform (-p) <PLATFORM></a> : The platform for which the dependency should be modified. Must be the name of a platform already defined in the workspace

May be provided more than once.

<a id="arg---feature" href="#arg---feature">--feature (-f) <FEATURE></a> : The feature for which the dependency should be modified

default: default

<a id="arg---environment" href="#arg---environment">--environment (-e) <ENVIRONMENT></a> : The environment for which the dependency should be modified. The dependency is written to the content defined inline on the environment, creating the environment if it does not exist
<a id="arg---editable" href="#arg---editable">--editable</a> : Whether the pypi requirement should be editable
<a id="arg---index" href="#arg---index">--index <INDEX></a> : The PyPI index URL to use for this dependency. Only applicable when adding pypi dependencies

Config Options

<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---offline" href="#arg---offline">--offline=<OFFLINE></a> : Run without network access, using only cached data. Commands fail if data is missing from the cache. Pass --offline=false to override an offline setting from the configuration

env: PIXI_OFFLINE

options: y, yes, t, true, on, 1, n, no, f, false, off, 0

<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)
<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

Git Options

<a id="arg---git" href="#arg---git">--git (-g) <GIT></a> : The git url to use when adding a git dependency
<a id="arg---branch" href="#arg---branch">--branch <BRANCH></a> : The git branch
<a id="arg---tag" href="#arg---tag">--tag <TAG></a> : The git tag
<a id="arg---rev" href="#arg---rev">--rev <REV></a> : The git revision
<a id="arg---subdirectory" href="#arg---subdirectory">--subdirectory <SUBDIRECTORY></a> : The subdirectory of the git repository to use

Update Options

<a id="arg---no-install" href="#arg---no-install">--no-install</a> : Don't modify the environment, only modify the lock file

env: PIXI_NO_INSTALL

<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
<a id="arg---script" href="#arg---script">--script (-s) <SCRIPT></a> : The path to a Python script containing PEP 723 metadata

Description

Adds dependencies to the workspace

The dependencies should be defined as MatchSpec for conda package, a PyPI requirement for the --pypi dependencies, or an absolute path to a local .conda or .tar.bz2 package file. If no specific version is provided, the latest version compatible with your workspace will be chosen automatically or a * will be used.

Example usage:

pixi add python=3.9: This will select the latest minor version that complies with 3.9.*, i.e., python version 3.9.0, 3.9.1, 3.9.2, etc.
pixi add python: In absence of a specified version, the latest version will be chosen. For instance, this could resolve to python version 3.11.3.* at the time of writing.

Adding multiple dependencies at once is also supported:

pixi add python pytest: This will add both python and pytest to the workspace's dependencies.

The --platform and --build/--host flags make the dependency target specific.

pixi add python --platform linux-64 --platform osx-arm64: Will add the latest version of python for linux-64 and osx-arm64 platforms.
pixi add python --build: Will add the latest version of python for as a build dependency.

Mixing --platform and --build/--host flags is supported

The --pypi option will add the package as a pypi dependency. This cannot be mixed with the conda dependencies

pixi add --pypi boto3
pixi add --pypi "boto3==version"

If the workspace manifest is a pyproject.toml, adding a pypi dependency will add it to the native pyproject project.dependencies array or to the native dependency-groups table if a feature is specified:

pixi add --pypi boto3 will add boto3 to the project.dependencies array
pixi add --pypi boto3 --feature aws will add boto3 to the dependency-groups.aws array
pixi add --pypi --editable 'boto3 @ file://absolute/path/to/boto3' will add the local editable boto3 to the pypi-dependencies array

Note that if --platform or --editable are specified, the pypi dependency will be added to the tool.pixi.pypi-dependencies table instead as native arrays have no support for platform-specific or editable dependencies.

These dependencies will then be read by pixi as if they had been added to the pixi pypi-dependencies tables of the default or of a named feature.

The versions will be automatically added with a pinning strategy based on semver or the pinning strategy set in the config. There is a list of packages that are not following the semver versioning scheme but will use the minor version by default: Python, Rust, Julia, GCC, GXX, GFortran, NodeJS, Deno, R, R-Base, Perl

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