-
Notifications
You must be signed in to change notification settings - Fork 314
docs: Update docs with pixi-extensions
#4144
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.
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
base: main
Are you sure you want to change the base?
docs: Update docs with pixi-extensions
#4144
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
a few nits bit otherwise this reads great to me, nice stuff! Super cool functionality also, looking forward to seeing which extensions people develop :)
### 1. PATH Environment Variable | ||
Pixi searches all directories in your `PATH` environment variable for executables with the `pixi-` prefix. | ||
|
||
### 2. Pixi Global Directories |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: maybe we want this instead? I don't have a strong opinion though
### 2. Pixi Global Directories | |
### 2. `pixi global` Directories |
|
||
### Using Pixi Global (Recommended) | ||
|
||
The easiest way to install pixi extensions is using `pixi global install`: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit (here and elsewhere)
The easiest way to install pixi extensions is using `pixi global install`: | |
The easiest way to install Pixi extensions is using `pixi global install`: |
This approach has several advantages: | ||
- **Isolated environments**: Each extension gets its own environment, preventing dependency conflicts | ||
- **Automatic discovery**: Extensions are automatically found by pixi without modifying PATH | ||
- **Easy management**: Use `pixi global list` and `pixi global remove` to manage extensions | ||
- **Consistent experience**: Extensions appear in `pixi --help` just like built-in commands |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 but maybe this text (for the first three points) belongs in global
docs, and we can just link out to it in one sentence?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yup makes sense! To me, it sounded like it's repeating. Seemed like I had read it somewhere else in the docs. Will resolve this 👍🏽
pixi global install pixi-pack | ||
|
||
# Install multiple extensions at once | ||
pixi global install pixi-pack pixi-diff rattler-build |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is rattler-build doing here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ahh!! just wanted to show what the user can install with pixi global 😅, will remove that.
for #3994