Back to Pixi

pixi list

docs/reference/cli/pixi/list.md

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

pixi list

List the packages of the current workspace

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

Usage

pixi list [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 <PLATFORM></a> : The platform to list packages for. Defaults to the platform best matching this machine. Accepts a workspace platform name; a bare conda subdir (e.g. linux-64) is also accepted
  • <a id="arg---json" href="#arg---json">--json</a> : Whether to output in json format
  • <a id="arg---sort-by" href="#arg---sort-by">--sort-by <SORT_BY></a> : Sorting strategy

default: name

options: size, name, kind

  • <a id="arg---fields" href="#arg---fields">--fields <FIELDS></a> : Select which fields to display and in what order (comma-separated)

May be provided more than once.

default: name, version, build, size, kind, source

options: arch, build, build-number, constrains, depends, file-name, is-editable, kind, license, license-family, md5, name, noarch, platform, requested-spec, sha256, size, source, subdir, timestamp, track-features, url, version

  • <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---explicit" href="#arg---explicit">--explicit (-x)</a> : Only list packages that are explicitly defined in the workspace

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

List the packages of the current workspace

Highlighted packages are explicit dependencies.

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