pixi is a cross-platform, multi-language package manager and workflow tool built on the foundation of the conda ecosystem. It provides developers with an exceptional experience similar to popular package managers like cargo or yarn, but for any language.
Developed with ❤️ at prefix.dev.
- Supports multiple languages including Python, C++, and R using Conda packages. You can find available packages on prefix.dev.
- Compatible with all major operating systems: Linux, Windows, macOS (including Apple Silicon).
- Always includes an up-to-date lockfile.
- Provides a clean and simple Cargo-like command-line interface.
- Allows you to install tools per-project or system-wide.
- Entirely written in Rust and built on top of the rattler library.
This project is currently in the alpha stage. It's actively under development, and we're planning to add many more features. The file formats are still subject to change, and you should expect breaking changes as we work towards a v1.0.
Some notable features we have in the pipeline are:
- Build and publish your project as a Conda package.
- Support for PyPi packages.
- Support for dependencies from source.
- Improvements to documentation, examples, and user experience.
pixi can be installed on macOS, Linux, and Windows. The provided scripts will automatically download the latest version of pixi, extract it, and move the pixi binary to ~/.pixi/bin. If this directory does not exist, the script will create it.
To install Pixi on macOS and Linux, open a terminal and run the following command:
curl -fsSL https://pixi.sh/install.sh | bash
# or with brew
brew install pixiThe script will also update your ~/.bash_profile to include ~/.pixi/bin in your PATH, allowing you to invoke the pixi command from anywhere. You might need to restart your terminal or source your shell for the changes to take effect.
pixi is also available in the AUR. If you're using paru:
paru -S pixiTo install Pixi on Windows, open a PowerShell terminal (you may need to run it as an administrator) and run the following command:
iwr -useb https://pixi.sh/install.ps1 | iexThe script will inform you once the installation is successful and add the ~/.pixi/bin directory to your PATH, which will allow you to run the pixi command from any location.
Or with winget
winget install prefix-dev.pixi
To get autocompletion run:
# On unix (MacOS or Linux), pick your shell (use `echo $SHELL` to find the shell you are using.):
echo 'eval "$(pixi completion --shell bash)"' >> ~/.bashrc
echo 'eval "$(pixi completion --shell zsh)"' >> ~/.zshrc
echo 'pixi completion --shell fish | source' >> ~/.config/fish/config.fish
echo 'eval (pixi completion --shell elvish | slurp)' >> ~/.elvish/rc.elvFor PowerShell on Windows, run the following command and then restart the shell or source the shell config file:
Add-Content -Path $PROFILE -Value '(& pixi completion --shell powershell) | Out-String | Invoke-Expression'And then restart the shell or source the shell config file.
pixi is 100% written in Rust and therefore it can be installed, built and tested with cargo.
To start using pixi from a source build run:
cargo install --locked pixi
# Or to use the the latest `main` branch
cargo install --locked --git https://github.com/prefix-dev/pixi.gitor when you want to make changes use:
cargo build
cargo testIf you have any issues building because of the dependency on rattler checkout
it's compile steps
To uninstall the pixi binary should be removed.
Delete pixi from the $PIXI_DIR which is default to ~/.pixi/bin/pixi
So on Linux its:
rm ~/.pixi/bin/pixiand on Windows:
$PIXI_BIN = "$Env:LocalAppData\pixi\bin\pixi"; Remove-Item -Path $PIXI_BINAfter this command you can still use the tools you installed with pixi.
To remove these as well just remove the whole ~/.pixi directory and remove the directory from your path.
The cli looks as follows:
➜ pixi
A package management and workflow tool
Usage: pixi [OPTIONS] <COMMAND>
Commands:
completion Generates a completion script for a shell
init Creates a new project
add Adds a dependency to the project
run Runs task in project
shell Start a shell in the pixi environment of the project
global Global is the main entry point for the part of pixi that executes on the global(system) level
auth Login to prefix.dev or anaconda.org servers to access private channels
install Install all dependencies
task Command management in project
info Information about the system and project
upload Upload a package to a prefix.dev channel
search Search a package, output will list the latest version of package
project
help Print this message or the help of the given subcommand(s)
Options:
-v, --verbose... More output per occurrence
-q, --quiet... Less output per occurrence
--color <COLOR> Whether the log needs to be colored [default: auto] [possible values: always, never, auto]
-h, --help Print help
-V, --version Print version
Initialize a new project and navigate to the project directory
pixi init myproject
cd myproject
Add the dependencies you want to use
pixi add cowpy
Run the installed package in its environment
pixi run cowpy "Thanks for using pixi"Activate a shell in the environment
pixi shell
cowpy "Thanks for using pixi"
exitYou can also globally install conda packages into their own environment.
This behavior is similar to pipx or condax.
pixi global install cowpyYou can use pixi in GitHub Actions to install dependencies and run commands.
- uses: prefix-dev/[email protected]
with:
cache: true
- run: pixi run cowpy "Thanks for using pixi"We would absolutely love for you to contribute to pixi!
Whether you want to start an issue, fix a bug you encountered, or suggest an
improvement, every contribution is greatly appreciated.
If you're just getting started with our project or stepping into the Rust
ecosystem for the first time, we've got your back!
We recommend beginning with issues labeled as good first issue.
These are carefully chosen tasks that provide a smooth entry point into
contributing.These issues are typically more straightforward and are a great way
to get familiar with the project.
Got questions or ideas, or just want to chat? Join our lively conversations on Discord. We're very active and would be happy to welcome you to our community. Join our discord server today!
To see what's being built with pixi check out the Community page.