Back to Pixi

pixi

docs/reference/cli/pixi.md

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

pixi

--8<-- "docs/reference/cli/pixi_extender:description"

Usage

pixi [OPTIONS] [COMMAND]

Subcommands

CommandDescription
addAdds dependencies to the workspace
authLogin to prefix.dev or anaconda.org servers to access private channels
cleanCleanup the environments
completionGenerates a completion script for a shell
configConfiguration management
execRun a command and install it in a temporary environment
globalSubcommand for global package management actions
infoInformation about the system, workspace and environments for the current machine
initCreates a new workspace
importImports a file into an environment in an existing workspace.
installInstall an environment, both updating the lock file and installing the environment
listList the packages of the current workspace
lockSolve environment and update the lock file without installing the environments
reinstallRe-install an environment, both updating the lock file and re-installing the environment
publishBuild a conda package and publish it to a channel.
removeRemoves dependencies from the workspace
runRuns task in the pixi environment
searchSearch a conda package
self-updateUpdate pixi to the latest version or a specific version
shellStart a shell in a pixi environment, run exit to leave the shell
shell-hookPrint the pixi environment activation script
taskInteract with tasks in the workspace
treeShow a tree of workspace dependencies
updateThe update command checks if there are newer versions of the dependencies and updates the pixi.lock file and environments accordingly
upgradeChecks if there are newer versions of the dependencies and upgrades them in the lock file and manifest file
uploadUpload conda packages to various channels
workspaceModify the workspace configuration file through the command line

Global Options

  • <a id="arg---help" href="#arg---help">--help (-h)</a> : Display help information
  • <a id="arg---verbose" href="#arg---verbose">--verbose (-v)</a> : Increase logging verbosity (-v for warnings, -vv for info, -vvv for debug, -vvvv for trace)
  • <a id="arg---quiet" href="#arg---quiet">--quiet (-q)</a> : Decrease logging verbosity (quiet mode)
  • <a id="arg---color" href="#arg---color">--color <COLOR></a> : Whether the log needs to be colored

env: PIXI_COLOR

default: auto

options: always, never, auto

  • <a id="arg---no-progress" href="#arg---no-progress">--no-progress</a> : Hide all progress bars, always turned on if stderr is not a terminal

env: PIXI_NO_PROGRESS

default: false

  • <a id="arg---list" href="#arg---list">--list</a> : List all installed commands (built-in and extensions)

--8<-- "docs/reference/cli/pixi_extender:example"