Basic usageTaking your first steps with pixi

Danger

This is the old documentation website please visit the new site

Make sure that you have pixi installed, this should print the help function, check the installation manual if it doesn't.

pixi

Initialize a new project and navigate to the project directory.

pixi init pixi-hello-world
cd pixi-hello-world

Add the dependencies you would like to use.

pixi add python

Create a file named hello_world.py in the directory and paste the following code into the file.

hello_world.py
def hello():
    print("Hello World, to the new revolution in package management.")
 
if __name__ == "__main__":
    hello()

Run the code inside the environment.

pixi run python hello_world.py

You can also put this run command in a task.

pixi task add hello python hello_world.py

After adding the task, you can run the task using its name.

pixi run hello

Use the shell command to activate the environment and start a new shell in there.

pixi shell
python
exit

You've just learned the basic features of pixi:

  1. adding a dependency.
  2. adding a task, and executing it.
  3. running a program. Feel free to play around with what you just learned like adding more tasks, dependencies or code. If you want to learn more, checkout out our in-depth documentation

Happy coding!

Use pixi as an installation tool

Use pixi to install tools on your machine.

Some notable examples:

# Awesome cross shell prompt, huge tip when using pixi!
pixi global install starship
 
# Want to try a different shell?
pixi global install fish
 
# Install other prefix.dev tools
pixi global install rattler-build
 
# Install a linter you want to use in multiple projects.
pixi global install ruff