Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
4 changes: 2 additions & 2 deletions docs/reference/cli/pixi.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!--- This file is autogenerated. Do not edit manually! -->
# <code>pixi</code>

--8<-- "docs/reference/cli/pixi_extender.md:description"
--8<-- "docs/reference/cli/pixi_extender:description"

## Usage
```
Expand Down Expand Up @@ -56,4 +56,4 @@ pixi [OPTIONS] <COMMAND>
<br>**env**: `PIXI_NO_PROGRESS`
<br>**default**: `false`

--8<-- "docs/reference/cli/pixi_extender.md:example"
--8<-- "docs/reference/cli/pixi_extender:example"
4 changes: 2 additions & 2 deletions docs/reference/cli/pixi/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## About
Adds dependencies to the workspace

--8<-- "docs/reference/cli/pixi/add_extender.md:description"
--8<-- "docs/reference/cli/pixi/add_extender:description"

## Usage
```
Expand Down Expand Up @@ -132,4 +132,4 @@ the minor version by default:
Python, Rust, Julia, GCC, GXX, GFortran, NodeJS, Deno, R, R-Base, Perl


--8<-- "docs/reference/cli/pixi/add_extender.md:example"
--8<-- "docs/reference/cli/pixi/add_extender:example"
4 changes: 2 additions & 2 deletions docs/reference/cli/pixi/auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## About
Login to prefix.dev or anaconda.org servers to access private channels

--8<-- "docs/reference/cli/pixi/auth_extender.md:description"
--8<-- "docs/reference/cli/pixi/auth_extender:description"

## Usage
```
Expand All @@ -18,4 +18,4 @@ pixi auth <COMMAND>
| [`logout`](auth/logout.md) | Remove authentication information for a given host |


--8<-- "docs/reference/cli/pixi/auth_extender.md:example"
--8<-- "docs/reference/cli/pixi/auth_extender:example"
4 changes: 2 additions & 2 deletions docs/reference/cli/pixi/auth/login.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## About
Store authentication information for a given host

--8<-- "docs/reference/cli/pixi/auth/login_extender.md:description"
--8<-- "docs/reference/cli/pixi/auth/login_extender:description"

## Usage
```
Expand Down Expand Up @@ -32,4 +32,4 @@ pixi auth login [OPTIONS] <HOST>
- <a id="arg---s3-session-token" href="#arg---s3-session-token">`--s3-session-token <S3_SESSION_TOKEN>`</a>
: The S3 session token

--8<-- "docs/reference/cli/pixi/auth/login_extender.md:example"
--8<-- "docs/reference/cli/pixi/auth/login_extender:example"
4 changes: 2 additions & 2 deletions docs/reference/cli/pixi/auth/logout.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## About
Remove authentication information for a given host

--8<-- "docs/reference/cli/pixi/auth/logout_extender.md:description"
--8<-- "docs/reference/cli/pixi/auth/logout_extender:description"

## Usage
```
Expand All @@ -16,4 +16,4 @@ pixi auth logout <HOST>
: The host to remove authentication for
<br>**required**: `true`

--8<-- "docs/reference/cli/pixi/auth/logout_extender.md:example"
--8<-- "docs/reference/cli/pixi/auth/logout_extender:example"
4 changes: 2 additions & 2 deletions docs/reference/cli/pixi/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## About
Workspace configuration

--8<-- "docs/reference/cli/pixi/build_extender.md:description"
--8<-- "docs/reference/cli/pixi/build_extender:description"

## Usage
```
Expand Down Expand Up @@ -40,4 +40,4 @@ pixi build [OPTIONS]
- <a id="arg---manifest-path" href="#arg---manifest-path">`--manifest-path <MANIFEST_PATH>`</a>
: The path to `pixi.toml`, `pyproject.toml`, or the workspace directory

--8<-- "docs/reference/cli/pixi/build_extender.md:example"
--8<-- "docs/reference/cli/pixi/build_extender:example"
4 changes: 2 additions & 2 deletions docs/reference/cli/pixi/clean.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## About
Cleanup the environments

--8<-- "docs/reference/cli/pixi/clean_extender.md:description"
--8<-- "docs/reference/cli/pixi/clean_extender:description"

## Usage
```
Expand Down Expand Up @@ -35,4 +35,4 @@ This command removes the information in the .pixi folder. You can specify the en
Use the `cache` subcommand to clean the cache.


--8<-- "docs/reference/cli/pixi/clean_extender.md:example"
--8<-- "docs/reference/cli/pixi/clean_extender:example"
4 changes: 2 additions & 2 deletions docs/reference/cli/pixi/clean/cache.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## About
Clean the cache of your system which are touched by pixi

--8<-- "docs/reference/cli/pixi/clean/cache_extender.md:description"
--8<-- "docs/reference/cli/pixi/clean/cache_extender:description"

## Usage
```
Expand Down Expand Up @@ -33,4 +33,4 @@ Clean the cache of your system which are touched by pixi.
Specify the cache type to clean with the flags.


--8<-- "docs/reference/cli/pixi/clean/cache_extender.md:example"
--8<-- "docs/reference/cli/pixi/clean/cache_extender:example"
4 changes: 2 additions & 2 deletions docs/reference/cli/pixi/completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## About
Generates a completion script for a shell

--8<-- "docs/reference/cli/pixi/completion_extender.md:description"
--8<-- "docs/reference/cli/pixi/completion_extender:description"

## Usage
```
Expand All @@ -17,4 +17,4 @@ pixi completion --shell <SHELL>
<br>**required**: `true`
<br>**options**: `bash`, `elvish`, `fish`, `nushell`, `powershell`, `zsh`

--8<-- "docs/reference/cli/pixi/completion_extender.md:example"
--8<-- "docs/reference/cli/pixi/completion_extender:example"
4 changes: 2 additions & 2 deletions docs/reference/cli/pixi/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## About
Configuration management

--8<-- "docs/reference/cli/pixi/config_extender.md:description"
--8<-- "docs/reference/cli/pixi/config_extender:description"

## Usage
```
Expand All @@ -22,4 +22,4 @@ pixi config <COMMAND>
| [`unset`](config/unset.md) | Unset a configuration value |


--8<-- "docs/reference/cli/pixi/config_extender.md:example"
--8<-- "docs/reference/cli/pixi/config_extender:example"
4 changes: 2 additions & 2 deletions docs/reference/cli/pixi/config/append.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## About
Append a value to a list configuration key

--8<-- "docs/reference/cli/pixi/config/append_extender.md:description"
--8<-- "docs/reference/cli/pixi/config/append_extender:description"

## Usage
```
Expand Down Expand Up @@ -37,4 +37,4 @@ Append a value to a list configuration key
Example: `pixi config append default-channels bioconda`


--8<-- "docs/reference/cli/pixi/config/append_extender.md:example"
--8<-- "docs/reference/cli/pixi/config/append_extender:example"
4 changes: 2 additions & 2 deletions docs/reference/cli/pixi/config/edit.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## About
Edit the configuration file

--8<-- "docs/reference/cli/pixi/config/edit_extender.md:description"
--8<-- "docs/reference/cli/pixi/config/edit_extender:description"

## Usage
```
Expand All @@ -28,4 +28,4 @@ pixi config edit [OPTIONS] [EDITOR]
- <a id="arg---manifest-path" href="#arg---manifest-path">`--manifest-path <MANIFEST_PATH>`</a>
: The path to `pixi.toml`, `pyproject.toml`, or the workspace directory

--8<-- "docs/reference/cli/pixi/config/edit_extender.md:example"
--8<-- "docs/reference/cli/pixi/config/edit_extender:example"
4 changes: 2 additions & 2 deletions docs/reference/cli/pixi/config/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## About
List configuration values

--8<-- "docs/reference/cli/pixi/config/list_extender.md:description"
--8<-- "docs/reference/cli/pixi/config/list_extender:description"

## Usage
```
Expand Down Expand Up @@ -37,4 +37,4 @@ List configuration values
Example: `pixi config list default-channels`


--8<-- "docs/reference/cli/pixi/config/list_extender.md:example"
--8<-- "docs/reference/cli/pixi/config/list_extender:example"
4 changes: 2 additions & 2 deletions docs/reference/cli/pixi/config/prepend.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## About
Prepend a value to a list configuration key

--8<-- "docs/reference/cli/pixi/config/prepend_extender.md:description"
--8<-- "docs/reference/cli/pixi/config/prepend_extender:description"

## Usage
```
Expand Down Expand Up @@ -37,4 +37,4 @@ Prepend a value to a list configuration key
Example: `pixi config prepend default-channels bioconda`


--8<-- "docs/reference/cli/pixi/config/prepend_extender.md:example"
--8<-- "docs/reference/cli/pixi/config/prepend_extender:example"
4 changes: 2 additions & 2 deletions docs/reference/cli/pixi/config/set.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## About
Set a configuration value

--8<-- "docs/reference/cli/pixi/config/set_extender.md:description"
--8<-- "docs/reference/cli/pixi/config/set_extender:description"

## Usage
```
Expand Down Expand Up @@ -36,4 +36,4 @@ Set a configuration value
Example: `pixi config set default-channels '["conda-forge", "bioconda"]'`


--8<-- "docs/reference/cli/pixi/config/set_extender.md:example"
--8<-- "docs/reference/cli/pixi/config/set_extender:example"
4 changes: 2 additions & 2 deletions docs/reference/cli/pixi/config/unset.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## About
Unset a configuration value

--8<-- "docs/reference/cli/pixi/config/unset_extender.md:description"
--8<-- "docs/reference/cli/pixi/config/unset_extender:description"

## Usage
```
Expand Down Expand Up @@ -34,4 +34,4 @@ Unset a configuration value
Example: `pixi config unset default-channels`


--8<-- "docs/reference/cli/pixi/config/unset_extender.md:example"
--8<-- "docs/reference/cli/pixi/config/unset_extender:example"
4 changes: 2 additions & 2 deletions docs/reference/cli/pixi/exec.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## About
Run a command and install it in a temporary environment

--8<-- "docs/reference/cli/pixi/exec_extender.md:description"
--8<-- "docs/reference/cli/pixi/exec_extender:description"

## Usage
```
Expand Down Expand Up @@ -50,4 +50,4 @@ Run a command and install it in a temporary environment.
Remove the temporary environments with `pixi clean cache --exec`.


--8<-- "docs/reference/cli/pixi/exec_extender.md:example"
--8<-- "docs/reference/cli/pixi/exec_extender:example"
4 changes: 2 additions & 2 deletions docs/reference/cli/pixi/global.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## About
Subcommand for global package management actions

--8<-- "docs/reference/cli/pixi/global_extender.md:description"
--8<-- "docs/reference/cli/pixi/global_extender:description"

## Usage
```
Expand Down Expand Up @@ -32,4 +32,4 @@ Subcommand for global package management actions.
Install packages on the user level. Into to the [`$PIXI_HOME`] directory, which defaults to `~/.pixi`.


--8<-- "docs/reference/cli/pixi/global_extender.md:example"
--8<-- "docs/reference/cli/pixi/global_extender:example"
4 changes: 2 additions & 2 deletions docs/reference/cli/pixi/global/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## About
Adds dependencies to an environment

--8<-- "docs/reference/cli/pixi/global/add_extender.md:description"
--8<-- "docs/reference/cli/pixi/global/add_extender:description"

## Usage
```
Expand Down Expand Up @@ -47,4 +47,4 @@ Example:
- `pixi global add --environment my_env pytest pytest-cov --expose pytest=pytest`


--8<-- "docs/reference/cli/pixi/global/add_extender.md:example"
--8<-- "docs/reference/cli/pixi/global/add_extender:example"
4 changes: 2 additions & 2 deletions docs/reference/cli/pixi/global/edit.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## About
Edit the global manifest file

--8<-- "docs/reference/cli/pixi/global/edit_extender.md:description"
--8<-- "docs/reference/cli/pixi/global/edit_extender:description"

## Usage
```
Expand All @@ -22,4 +22,4 @@ Edit the global manifest file
Opens your editor to edit the global manifest file.


--8<-- "docs/reference/cli/pixi/global/edit_extender.md:example"
--8<-- "docs/reference/cli/pixi/global/edit_extender:example"
4 changes: 2 additions & 2 deletions docs/reference/cli/pixi/global/expose.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## About
Interact with the exposure of binaries in the global environment

--8<-- "docs/reference/cli/pixi/global/expose_extender.md:description"
--8<-- "docs/reference/cli/pixi/global/expose_extender:description"

## Usage
```
Expand All @@ -26,4 +26,4 @@ Interact with the exposure of binaries in the global environment
`pixi global expose remove python310 --environment myenv` will remove the exposed name `python310` from the environment `myenv`


--8<-- "docs/reference/cli/pixi/global/expose_extender.md:example"
--8<-- "docs/reference/cli/pixi/global/expose_extender:example"
4 changes: 2 additions & 2 deletions docs/reference/cli/pixi/global/expose/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## About
Add exposed binaries from an environment to your global environment

--8<-- "docs/reference/cli/pixi/global/expose/add_extender.md:description"
--8<-- "docs/reference/cli/pixi/global/expose/add_extender:description"

## Usage
```
Expand Down Expand Up @@ -43,4 +43,4 @@ Example:
- `pixi global add --environment my_env pytest pytest-cov --expose pytest=pytest`


--8<-- "docs/reference/cli/pixi/global/expose/add_extender.md:example"
--8<-- "docs/reference/cli/pixi/global/expose/add_extender:example"
4 changes: 2 additions & 2 deletions docs/reference/cli/pixi/global/expose/remove.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## About
Remove exposed binaries from the global environment

--8<-- "docs/reference/cli/pixi/global/expose/remove_extender.md:description"
--8<-- "docs/reference/cli/pixi/global/expose/remove_extender:description"

## Usage
```
Expand Down Expand Up @@ -35,4 +35,4 @@ Remove exposed binaries from the global environment
`pixi global expose remove python310 python3 --environment myenv` will remove the exposed names `python310` and `python3` from the environment `myenv`


--8<-- "docs/reference/cli/pixi/global/expose/remove_extender.md:example"
--8<-- "docs/reference/cli/pixi/global/expose/remove_extender:example"
4 changes: 2 additions & 2 deletions docs/reference/cli/pixi/global/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## About
Installs the defined packages in a globally accessible location and exposes their command line applications.

--8<-- "docs/reference/cli/pixi/global/install_extender.md:description"
--8<-- "docs/reference/cli/pixi/global/install_extender:description"

## Usage
```
Expand Down Expand Up @@ -60,4 +60,4 @@ Example:
- `pixi global install --environment science --expose jupyter --expose ipython jupyter ipython polars`


--8<-- "docs/reference/cli/pixi/global/install_extender.md:example"
--8<-- "docs/reference/cli/pixi/global/install_extender:example"
4 changes: 2 additions & 2 deletions docs/reference/cli/pixi/global/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## About
Lists all packages previously installed into a globally accessible location via `pixi global install`.

--8<-- "docs/reference/cli/pixi/global/list_extender.md:description"
--8<-- "docs/reference/cli/pixi/global/list_extender:description"

## Usage
```
Expand Down Expand Up @@ -51,4 +51,4 @@ Per environment:
- Green: packages that are explicitly installed.


--8<-- "docs/reference/cli/pixi/global/list_extender.md:example"
--8<-- "docs/reference/cli/pixi/global/list_extender:example"
4 changes: 2 additions & 2 deletions docs/reference/cli/pixi/global/remove.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## About
Removes dependencies from an environment

--8<-- "docs/reference/cli/pixi/global/remove_extender.md:description"
--8<-- "docs/reference/cli/pixi/global/remove_extender:description"

## Usage
```
Expand Down Expand Up @@ -42,4 +42,4 @@ Use `pixi global uninstall` to remove the whole environment
Example: `pixi global remove --environment python numpy`


--8<-- "docs/reference/cli/pixi/global/remove_extender.md:example"
--8<-- "docs/reference/cli/pixi/global/remove_extender:example"
Loading