Skip to content

docs: small typo fix #5460

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lucascolley merged 1 commit into from
Feb 7, 2026
Merged

docs: small typo fix #5460

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions docs/global_tools/introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,10 @@
</video>
</div>


With `pixi global`, users can manage globally installed tools in a way that makes them available from any directory.
This means that the Pixi environment will be placed in a global location, and the tools will be exposed to the system `PATH`, allowing you to run them from the command line.
Some packages, especially those with graphical user interfaces, will also add start menu entries.


## Basic Usage

Running the following command installs [`rattler-build`](https://prefix-dev.github.io/rattler-build/latest/) on your system.
Expand All @@ -37,6 +35,7 @@ pixi global install ipython --with numpy --with matplotlib
`numpy` exposes executables, but since it's added via `--with` it's executables are not being exposed.

Importing `numpy` and `matplotlib` now works as expected.

```bash
ipython -c 'import numpy; import matplotlib'
```
Expand All @@ -45,6 +44,7 @@ At some point, you might want to install multiple versions of the same package o
Since they will be all available on the system `PATH`, they need to be exposed under different names.

Let's check out the following command:

```bash
pixi global install --expose py3=python "python=3.12"
```
Expand All @@ -53,6 +53,7 @@ By specifying `--expose` we specified that we want to expose the executable `pyt
The package `python` has more executables, but since we specified `--exposed` they are not auto-exposed.

You can run `py3` to start the python interpreter.

```shell
py3 -c "print('Hello World')"
```
Expand Down Expand Up @@ -129,7 +130,6 @@ In this case, we have to specify which output we want to install:
pixi global install --path /path/to/package foobar
```


## Shell Completions

When you work in a terminal, you are using a shell and shells can process completions of command line tools.
Expand All @@ -139,7 +139,6 @@ However, that only works if you have the completions installed for the tool in q
If the tool you installed via `pixi global` contains completions they will be automatically installed.
At the moment, only Linux and macOS are supported.


First install a tool with `pixi global`:

```shell
Expand Down Expand Up @@ -175,10 +174,9 @@ end

Completions of packages are installed as long as their binaries are exposed under the same name: e.g. `exposed = { git = "git" }`.


## Adding a Series of Tools at Once

Without specifying an inastallation environment, you can add multiple tools at once:
Without specifying an installation environment, you can add multiple tools at once:

```shell
pixi global install pixi-pack rattler-build
Expand Down Expand Up @@ -232,10 +230,13 @@ These commands will be available globally, making it easy to access your preferr
You can install packages for a different platform using the `--platform` flag.
This is useful when you want to install packages for a different platform, such as `osx-64` packages on `osx-arm64`.
For example, running this on `osx-arm64`:

```shell
pixi global install --platform osx-64 python
```

will create the following entry in the manifest:

```toml
[envs.python]
channels = ["conda-forge"]
Expand Down