Back to Pixi

pixi global install

docs/reference/cli/pixi/global/install.md

0.71.25.0 KB
Original Source
<!--- This file is autogenerated. Do not edit manually! -->

pixi global install

Installs the defined packages in a globally accessible location and exposes their command line applications.

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

Usage

pixi global install [OPTIONS] [PACKAGE]...

Arguments

  • <a id="arg-<PACKAGE>" href="#arg-<PACKAGE>"><PACKAGE></a> : The dependency as names, conda MatchSpecs

May be provided more than once.

Options

  • <a id="arg---path" href="#arg---path">--path <PATH></a> : The path to the local package
  • <a id="arg---channel" href="#arg---channel">--channel (-c) <CHANNEL></a> : The channels to consider as a name or a url. Multiple channels can be specified by using this field multiple times

May be provided more than once.

  • <a id="arg---platform" href="#arg---platform">--platform (-p) <PLATFORM></a> : The platform to install the packages for
  • <a id="arg---environment" href="#arg---environment">--environment (-e) <ENVIRONMENT></a> : Ensures that all packages will be installed in the same environment
  • <a id="arg---expose" href="#arg---expose">--expose <EXPOSE></a> : Add one or more mapping which describe which executables are exposed. The syntax is exposed_name=executable_name, so for example python3.10=python. Alternatively, you can input only an executable_name and executable_name=executable_name is assumed

May be provided more than once.

  • <a id="arg---with" href="#arg---with">--with <WITH></a> : Add additional dependencies to the environment. Their executables will not be exposed

May be provided more than once.

  • <a id="arg---force-reinstall" href="#arg---force-reinstall">--force-reinstall</a> : Specifies that the environment should be reinstalled
  • <a id="arg---no-shortcuts" href="#arg---no-shortcuts">--no-shortcuts</a> : Specifies that no shortcuts should be created for the installed packages

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

Git Options

  • <a id="arg---git" href="#arg---git">--git <GIT></a> : The git url, e.g. https://github.com/user/repo.git
  • <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---subdir" href="#arg---subdir">--subdir <SUBDIR></a> : The subdirectory within the git repository

Description

Installs the defined packages in a globally accessible location and exposes their command line applications.

Example:

  • pixi global install starship nushell ripgrep bat
  • pixi global install jupyter --with polars
  • pixi global install --expose python3.8=python python=3.8
  • pixi global install --environment science --expose jupyter --expose ipython jupyter ipython polars

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