Skip to content

Commit 2d47601

Browse files
KemingHegithub-actions[bot]
KemingHe
authored and
github-actions[bot]
committed
docs(src/assets/): update pixi official documentation
1 parent 36b78af commit 2d47601

File tree

18 files changed

+148
-34
lines changed

18 files changed

+148
-34
lines changed

‎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": "2025-08-26T22:05:24Z",
5-
"commit_sha": "77a0a4c9a6d76d7389a48c3c2aa91ae1ed2c2a13"
4+
"updated_at": "2025-09-02T22:05:15Z",
5+
"commit_sha": "bb2e54da3483cf81aec983b30038a39df0cb2609"
66
}

‎src/assets/pixi/integration/ci/github_actions.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ We created [prefix-dev/setup-pixi](https://github.com/prefix-dev/setup-pixi) to
1010
```yaml
1111
- uses: prefix-dev/setup-pixi@v0.9.0
1212
with:
13-
pixi-version: v0.53.0
13+
pixi-version: v0.54.0
1414
cache: true
1515
auth-host: prefix.dev
1616
auth-token: ${{ secrets.PREFIX_DEV_TOKEN }}

‎src/assets/pixi/integration/editor/vscode.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Then, create the following two files in the `.devcontainer` directory:
2828
```dockerfile title=".devcontainer/Dockerfile"
2929
FROM mcr.microsoft.com/devcontainers/base:jammy
3030

31-
ARG PIXI_VERSION=v0.53.0
31+
ARG PIXI_VERSION=v0.54.0
3232

3333
RUN curl -L -o /usr/local/bin/pixi -fsSL --compressed "https://github.com/prefix-dev/pixi/releases/download/${PIXI_VERSION}/pixi-$(uname -m)-unknown-linux-musl" \
3434
&& chmod +x /usr/local/bin/pixi \

‎src/assets/pixi/reference/cli/pixi/add.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,16 @@ pixi add [OPTIONS] <SPEC>...
6464
## Update Options
6565
- <a id="arg---no-install" href="#arg---no-install">`--no-install`</a>
6666
: Don't modify the environment, only modify the lock-file
67-
- <a id="arg---frozen" href="#arg---frozen">`--frozen`</a>
67+
- <a id="arg---frozen" href="#arg---frozen">`--frozen=<FROZEN>`</a>
6868
: Install the environment as defined in the lockfile, doesn't update lockfile if it isn't up-to-date with the manifest file
6969
<br>**env**: `PIXI_FROZEN`
70-
- <a id="arg---locked" href="#arg---locked">`--locked`</a>
70+
<br>**default**: `false`
71+
<br>**options**: `true`, `false`
72+
- <a id="arg---locked" href="#arg---locked">`--locked=<LOCKED>`</a>
7173
: Check if lockfile is up-to-date before installing the environment, aborts when lockfile isn't up-to-date with the manifest file
7274
<br>**env**: `PIXI_LOCKED`
75+
<br>**default**: `false`
76+
<br>**options**: `true`, `false`
7377

7478
## Global Options
7579
- <a id="arg---manifest-path" href="#arg---manifest-path">`--manifest-path <MANIFEST_PATH>`</a>

‎src/assets/pixi/reference/cli/pixi/exec.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ pixi exec [OPTIONS] [COMMAND]...
3131
<br>**default**: `current_platform`
3232
- <a id="arg---force-reinstall" href="#arg---force-reinstall">`--force-reinstall`</a>
3333
: If specified a new environment is always created even if one already exists
34-
- <a id="arg---list" href="#arg---list">`--list <LIST>`</a>
34+
- <a id="arg---list" href="#arg---list">`--list=<LIST>`</a>
3535
: Before executing the command, list packages in the environment Specify `--list=some_regex` to filter the shown packages
3636
- <a id="arg---no-modify-ps1" href="#arg---no-modify-ps1">`--no-modify-ps1`</a>
3737
: Disable modification of the PS1 prompt to indicate the temporary environment

‎src/assets/pixi/reference/cli/pixi/install.md‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,13 @@ pixi install [OPTIONS]
1818
- <a id="arg---all" href="#arg---all">`--all (-a)`</a>
1919
: Install all environments
2020
- <a id="arg---skip" href="#arg---skip">`--skip <SKIP>`</a>
21-
: Skip installation of specific packages present in the lockfile. Requires --frozen. This can be useful for instance in a Dockerfile to skip local source dependencies when installing dependencies
21+
: Skip installation of specific packages present in the lockfile. This uses a soft exclusion: the package will be skipped but its dependencies are installed
22+
<br>May be provided more than once.
23+
- <a id="arg---skip-with-deps" href="#arg---skip-with-deps">`--skip-with-deps <SKIP_WITH_DEPS>`</a>
24+
: Skip a package and its entire dependency subtree. This performs a hard exclusion: the package and its dependencies are not installed unless reachable from another non-skipped root
25+
<br>May be provided more than once.
26+
- <a id="arg---only" href="#arg---only">`--only <ONLY>`</a>
27+
: Install and build only these package(s) and their dependencies. Can be passed multiple times
2228
<br>May be provided more than once.
2329

2430
## Config Options
@@ -42,12 +48,16 @@ pixi install [OPTIONS]
4248
: Use environment activation cache (experimental)
4349

4450
## Update Options
45-
- <a id="arg---frozen" href="#arg---frozen">`--frozen`</a>
51+
- <a id="arg---frozen" href="#arg---frozen">`--frozen=<FROZEN>`</a>
4652
: Install the environment as defined in the lockfile, doesn't update lockfile if it isn't up-to-date with the manifest file
4753
<br>**env**: `PIXI_FROZEN`
48-
- <a id="arg---locked" href="#arg---locked">`--locked`</a>
54+
<br>**default**: `false`
55+
<br>**options**: `true`, `false`
56+
- <a id="arg---locked" href="#arg---locked">`--locked=<LOCKED>`</a>
4957
: Check if lockfile is up-to-date before installing the environment, aborts when lockfile isn't up-to-date with the manifest file
5058
<br>**env**: `PIXI_LOCKED`
59+
<br>**default**: `false`
60+
<br>**options**: `true`, `false`
5161

5262
## Global Options
5363
- <a id="arg---manifest-path" href="#arg---manifest-path">`--manifest-path <MANIFEST_PATH>`</a>

‎src/assets/pixi/reference/cli/pixi/list.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,16 @@ pixi list [OPTIONS] [REGEX]
3232
: Only list packages that are explicitly defined in the workspace
3333

3434
## Update Options
35-
- <a id="arg---frozen" href="#arg---frozen">`--frozen`</a>
35+
- <a id="arg---frozen" href="#arg---frozen">`--frozen=<FROZEN>`</a>
3636
: Install the environment as defined in the lockfile, doesn't update lockfile if it isn't up-to-date with the manifest file
3737
<br>**env**: `PIXI_FROZEN`
38-
- <a id="arg---locked" href="#arg---locked">`--locked`</a>
38+
<br>**default**: `false`
39+
<br>**options**: `true`, `false`
40+
- <a id="arg---locked" href="#arg---locked">`--locked=<LOCKED>`</a>
3941
: Check if lockfile is up-to-date before installing the environment, aborts when lockfile isn't up-to-date with the manifest file
4042
<br>**env**: `PIXI_LOCKED`
43+
<br>**default**: `false`
44+
<br>**options**: `true`, `false`
4145
- <a id="arg---no-install" href="#arg---no-install">`--no-install`</a>
4246
: Don't modify the environment, only modify the lock-file
4347

‎src/assets/pixi/reference/cli/pixi/reinstall.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,16 @@ pixi reinstall [OPTIONS] [PACKAGE]...
4444
: Use environment activation cache (experimental)
4545

4646
## Update Options
47-
- <a id="arg---frozen" href="#arg---frozen">`--frozen`</a>
47+
- <a id="arg---frozen" href="#arg---frozen">`--frozen=<FROZEN>`</a>
4848
: Install the environment as defined in the lockfile, doesn't update lockfile if it isn't up-to-date with the manifest file
4949
<br>**env**: `PIXI_FROZEN`
50-
- <a id="arg---locked" href="#arg---locked">`--locked`</a>
50+
<br>**default**: `false`
51+
<br>**options**: `true`, `false`
52+
- <a id="arg---locked" href="#arg---locked">`--locked=<LOCKED>`</a>
5153
: Check if lockfile is up-to-date before installing the environment, aborts when lockfile isn't up-to-date with the manifest file
5254
<br>**env**: `PIXI_LOCKED`
55+
<br>**default**: `false`
56+
<br>**options**: `true`, `false`
5357

5458
## Global Options
5559
- <a id="arg---manifest-path" href="#arg---manifest-path">`--manifest-path <MANIFEST_PATH>`</a>

‎src/assets/pixi/reference/cli/pixi/remove.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,12 +62,16 @@ pixi remove [OPTIONS] <SPEC>...
6262
## Update Options
6363
- <a id="arg---no-install" href="#arg---no-install">`--no-install`</a>
6464
: Don't modify the environment, only modify the lock-file
65-
- <a id="arg---frozen" href="#arg---frozen">`--frozen`</a>
65+
- <a id="arg---frozen" href="#arg---frozen">`--frozen=<FROZEN>`</a>
6666
: Install the environment as defined in the lockfile, doesn't update lockfile if it isn't up-to-date with the manifest file
6767
<br>**env**: `PIXI_FROZEN`
68-
- <a id="arg---locked" href="#arg---locked">`--locked`</a>
68+
<br>**default**: `false`
69+
<br>**options**: `true`, `false`
70+
- <a id="arg---locked" href="#arg---locked">`--locked=<LOCKED>`</a>
6971
: Check if lockfile is up-to-date before installing the environment, aborts when lockfile isn't up-to-date with the manifest file
7072
<br>**env**: `PIXI_LOCKED`
73+
<br>**default**: `false`
74+
<br>**options**: `true`, `false`
7175

7276
## Global Options
7377
- <a id="arg---manifest-path" href="#arg---manifest-path">`--manifest-path <MANIFEST_PATH>`</a>

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,16 @@ pixi run [OPTIONS] [TASK]...
5555
## Update Options
5656
- <a id="arg---no-install" href="#arg---no-install">`--no-install`</a>
5757
: Don't modify the environment, only modify the lock-file
58-
- <a id="arg---frozen" href="#arg---frozen">`--frozen`</a>
58+
- <a id="arg---frozen" href="#arg---frozen">`--frozen=<FROZEN>`</a>
5959
: Install the environment as defined in the lockfile, doesn't update lockfile if it isn't up-to-date with the manifest file
6060
<br>**env**: `PIXI_FROZEN`
61-
- <a id="arg---locked" href="#arg---locked">`--locked`</a>
61+
<br>**default**: `false`
62+
<br>**options**: `true`, `false`
63+
- <a id="arg---locked" href="#arg---locked">`--locked=<LOCKED>`</a>
6264
: Check if lockfile is up-to-date before installing the environment, aborts when lockfile isn't up-to-date with the manifest file
6365
<br>**env**: `PIXI_LOCKED`
66+
<br>**default**: `false`
67+
<br>**options**: `true`, `false`
6468
- <a id="arg---as-is" href="#arg---as-is">`--as-is`</a>
6569
: Shorthand for the combination of --no-install and --frozen
6670

0 commit comments

Comments
 (0)