Command cheat sheet¶

Every command links to its page in the Pixi documentation.

Workspace¶

Command	What it does
`pixi init`	Create a `pixi.toml` in the current directory
`pixi workspace channel add <channel>`	Add a channel
`pixi workspace platform add <platform>`	Add a platform
`pixi add <package>`	Add a dependency and update the lockfile
`pixi add --pypi <package>`	Add a dependency from PyPI
`pixi remove <package>`	Remove a dependency

Command	What it does
`pixi run <task>`	Run a task from `[tasks]`
`pixi run <command>`	Run any command inside the environment
`pixi shell`	Open a shell with the environment activated
`pixi run -e <env> <task>`	Run in a specific environment
`pixi task list`	List the available tasks

Command	What it does
`pixi install`	Install the environment from the lockfile
`pixi lock`	Update the lockfile without installing
`pixi lock --check`	Fail if the lockfile is out of date. Use this in CI
`pixi update <package>`	Update one package to the newest allowed version
`pixi list`	Show what is installed
`pixi tree <package>`	Show why a package is in the environment
`pixi clean`	Remove `.pixi/`

Command	What it does
`pixi info`	Versions, cache locations, and the virtual packages your machine reports (field by field)
`pixi search <package>`	Search the configured channels
`pixi list --platform <platform>`	What would be installed on another platform

Command	What it does
`pixi build`	Build the `[package]` in this workspace into a `.conda` file
`pixi publish`	Build and upload the package to a channel

The ROS build backend that turns a package.xml into a conda package is pixi-build-ros.

Topic	Page
Every field in `pixi.toml`	Manifest reference
All commands and flags	CLI reference
What the lockfile guarantees	Lockfile
Features, environments, and solve groups	Multi environment
Task dependencies, inputs, and outputs	Advanced tasks
Building your own ROS packages	Build a ROS package
Pixi for robotics, start to finish	Robotics and the ROS 2 tutorial