Back to Pixi

pixi tree

docs/reference/cli/pixi/tree.md

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

pixi tree

Show a tree of workspace dependencies

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

Usage

pixi tree [OPTIONS] [REGEX]

Arguments

  • <a id="arg-<REGEX>" href="#arg-<REGEX>"><REGEX></a> : List only packages matching a regular expression

Options

  • <a id="arg---platform" href="#arg---platform">--platform (-p) <PLATFORM></a> : The platform to list packages for. Defaults to the current platform
  • <a id="arg---environment" href="#arg---environment">--environment (-e) <ENVIRONMENT></a> : The environment to list packages for. Defaults to the default environment
  • <a id="arg---invert" href="#arg---invert">--invert (-i)</a> : Invert tree and show what depends on given package in the regex argument

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

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

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

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

Show a tree of workspace dependencies

Dependency names highlighted in green are directly specified in the manifest. Yellow version numbers are conda packages, PyPI version numbers are blue.

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