Skip to content
This repository was archived by the owner on Feb 15, 2026. It is now read-only.

Commit 01d0b1f

Browse files
KemingHegithub-actions[bot]
authored andcommitted
docs(src/assets/): update pixi official documentation
1 parent 7247dfe commit 01d0b1f

5 files changed

Lines changed: 62 additions & 10 deletions

File tree

src/assets/pixi/_metadata.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"source_repo": "prefix-dev/pixi",
33
"docs_path": "docs",
4-
"updated_at": "2026-01-20T22:06:21Z",
5-
"commit_sha": "c291577dcf9f9e85df7fe417cb472c5eb8e15199"
4+
"updated_at": "2026-01-27T22:06:40Z",
5+
"commit_sha": "bb5e1f751a0a5a0e62daea6157deae61f8e7c844"
66
}

src/assets/pixi/reference/cli/pixi/run.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ pixi run [OPTIONS] [TASK]...
1919
<br>May be provided more than once.
2020

2121
## Options
22+
- <a id="arg---executable" href="#arg---executable">`--executable (-x)`</a>
23+
: Execute the command as an executable without resolving Pixi tasks
2224
- <a id="arg---environment" href="#arg---environment">`--environment (-e) <ENVIRONMENT>`</a>
2325
: The environment to run the task in
2426
- <a id="arg---clean-env" href="#arg---clean-env">`--clean-env`</a>

src/assets/pixi/reference/pixi_manifest.md

Lines changed: 42 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -401,14 +401,15 @@ Pixi's tasks are run in a Pixi environment using `pixi run` and are executed usi
401401
```toml
402402
[tasks]
403403
simple = "echo This is a simple task"
404-
cmd = { cmd="echo Same as a simple task but now more verbose"}
405-
depending = { cmd="echo run after simple", depends-on="simple"}
406-
alias = { depends-on=["depending"]}
407-
download = { cmd="curl -o file.txt https://example.com/file.txt" , outputs=["file.txt"]}
408-
build = { cmd="npm build", cwd="frontend", inputs=["frontend/package.json", "frontend/*.js"]}
409-
run = { cmd="python run.py $ARGUMENT", env={ ARGUMENT="value" }}
404+
cmd = { cmd="echo Same as a simple task but now more verbose" }
405+
depending = { cmd="echo run after simple", depends-on="simple" }
406+
alias = { depends-on=["depending"] }
407+
download = { cmd="curl -o file.txt https://example.com/file.txt" , outputs=["file.txt"] }
408+
build = { cmd="npm build", cwd="frontend", inputs=["frontend/package.json", "frontend/*.js"] }
409+
run = { cmd="python run.py $ARGUMENT", env={ ARGUMENT="value" }} # Set an environment variable
410410
format = { cmd="black $INIT_CWD" } # runs black where you run pixi run format
411-
clean-env = { cmd = "python isolated.py", clean-env = true} # Only on Unix!
411+
clean-env = { cmd="python isolated.py", clean-env=true } # Only on Unix!
412+
test = { cmd="pytest", default-environment="test" } # Set a default pixi environment
412413
```
413414

414415
You can modify this table using [`pixi task`](cli/pixi/task.md).
@@ -461,6 +462,7 @@ The options that can be defined are:
461462
- `no-binary`: don't use pre-build wheels.
462463
- `index-strategy`: allows for specifying the index strategy to use.
463464
- `prerelease-mode`: controls whether pre-release versions are allowed during dependency resolution.
465+
- `skip-wheel-filename-check`: allows installing wheels with version mismatches between filename and metadata.
464466

465467
These options are explained in the sections below. Most of these options are taken directly or with slight modifications from the [uv settings](https://docs.astral.sh/uv/reference/settings/). If any are missing that you need feel free to create an issue [requesting](https://github.com/prefix-dev/pixi/issues) them.
466468

@@ -621,6 +623,39 @@ Example:
621623
prerelease-mode = "allow" # Allow all pre-release versions
622624
```
623625

626+
### Skip Wheel Filename Check
627+
628+
By default, `uv` validates that wheel filenames match the package metadata (name and version) inside the wheel. This validation ensures that wheels are correctly named and helps prevent installation of malformed packages.
629+
630+
However, in some cases you may need to install wheels where the filename version doesn't match the metadata version. The `skip-wheel-filename-check` option allows you to disable this validation.
631+
632+
!!! warning "One skip-wheel-filename-check per environment"
633+
Only one `skip-wheel-filename-check` can be defined per environment or solve-group, otherwise, an error will be shown.
634+
635+
#### Possible values:
636+
637+
- **`false`** (default): Perform wheel filename validation. Installation will fail if filename and metadata don't match.
638+
- **`true`**: Skip wheel filename validation. Allow installing wheels with mismatched filename and metadata versions.
639+
640+
#### Precedence
641+
642+
The `UV_SKIP_WHEEL_FILENAME_CHECK` environment variable takes precedence over the `skip-wheel-filename-check` pypi-option. This allows for temporary overrides without modifying the manifest.
643+
644+
645+
Example:
646+
```toml
647+
[pypi-options]
648+
# Allow installing malformed wheels
649+
skip-wheel-filename-check = true
650+
```
651+
652+
Or set per feature:
653+
```toml
654+
[feature.special.pypi-options]
655+
# Only for this feature's environment
656+
skip-wheel-filename-check = true
657+
```
658+
624659
## The `dependencies` table(s)
625660
??? info "Details regarding the dependencies"
626661
For more detail regarding the dependency types, make sure to check the [Run, Host, Build](../build/dependency_types.md) dependency documentation.

src/assets/pixi/tutorials/ros2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ hello = { cmd = "ros2 run my_package my_node", depends-on = ["build"] }
181181
To build a C++ node you need to add the `ament_cmake` and some other build dependencies to your manifest file.
182182

183183
```shell
184-
pixi add ros-humble-ament-cmake-auto compilers pkg-config cmake ninja
184+
pixi add ros-humble-ament-cmake-auto compilers pkg-config "cmake<4" ninja colcon-common-extensions
185185
```
186186

187187
Now you can create a C++ node with the following command

src/assets/pixi/workspace/advanced_tasks.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ set = "export VAR=hello && echo $VAR"
3131
copy = "cp pixi.toml pixi_backup.toml"
3232
clean = "rm pixi_backup.toml"
3333
move = "mv pixi.toml backup.toml"
34+
35+
# Setting a default environment for the task
36+
test = { cmd = "pytest", default-environment = "test" }
3437
```
3538

3639
## Depends on
@@ -157,6 +160,18 @@ This will add the following line to [manifest file](../reference/pixi_manifest.m
157160
bar = { cmd = "python bar.py", cwd = "scripts" }
158161
```
159162

163+
## Default environment
164+
165+
You can set the default Pixi [environment](../tutorials/multi_environment.md#adding-an-environment) used by a task using the `default-environment` field:
166+
```toml title="pixi.toml"
167+
--8<-- "docs/source_files/pixi_tomls/task_default_environment.toml:default-environment"
168+
```
169+
170+
The default environment can be overridden as usual with the `--environment` argument:
171+
```shell
172+
pixi run -e other_environment test
173+
```
174+
160175
## Task Arguments
161176

162177
Tasks can accept arguments that can be referenced in the command. This provides more flexibility and reusability for your tasks.

0 commit comments

Comments
 (0)