Skip to content

Commit 9ca4b15

Browse files
KemingHegithub-actions[bot]
authored andcommitted
docs(src/assets/): update pixi official documentation
1 parent aec873c commit 9ca4b15

File tree

8 files changed

+51
-12
lines changed

8 files changed

+51
-12
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-10-28T22:05:52Z",
5-
"commit_sha": "d1e724f8e37338c5b2d93277d39d0ef3fa5a7425"
4+
"updated_at": "2025-11-04T22:05:36Z",
5+
"commit_sha": "82061b47054e276ea428e3603fd15f3645e18ecb"
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.2
1212
with:
13-
pixi-version: v0.58.0
13+
pixi-version: v0.59.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.58.0
31+
ARG PIXI_VERSION=v0.59.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.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ pixi [OPTIONS] [COMMAND]
1313
|---------|-------------|
1414
| [`add`](pixi/add.md) | Adds dependencies to the workspace |
1515
| [`auth`](pixi/auth.md) | Login to prefix.dev or anaconda.org servers to access private channels |
16-
| [`build`](pixi/build.md) | Workspace configuration |
16+
| [`build`](pixi/build.md) | Lock file and installation configuration with --as-is support Used by shell, shell-hook, and run commands |
1717
| [`clean`](pixi/clean.md) | Cleanup the environments |
1818
| [`completion`](pixi/completion.md) | Generates a completion script for a shell |
1919
| [`config`](pixi/config.md) | Configuration management |
@@ -23,7 +23,7 @@ pixi [OPTIONS] [COMMAND]
2323
| [`init`](pixi/init.md) | Creates a new workspace |
2424
| [`import`](pixi/import.md) | Imports a file into an environment in an existing workspace. |
2525
| [`install`](pixi/install.md) | Install an environment, both updating the lockfile and installing the environment |
26-
| [`list`](pixi/list.md) | List workspace's packages |
26+
| [`list`](pixi/list.md) | List the packages of the current workspace |
2727
| [`lock`](pixi/lock.md) | Solve environment and update the lock file without installing the environments |
2828
| [`reinstall`](pixi/reinstall.md) | Re-install an environment, both updating the lockfile and re-installing the environment |
2929
| [`remove`](pixi/remove.md) | Removes dependencies from the workspace |

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

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# <code>[pixi](../pixi.md) build</code>
33

44
## About
5-
Workspace configuration
5+
Lock file and installation configuration with --as-is support Used by shell, shell-hook, and run commands
66

77
--8<-- "docs/reference/cli/pixi/build_extender:description"
88

@@ -46,6 +46,18 @@ pixi build [OPTIONS]
4646
- <a id="arg---use-environment-activation-cache" href="#arg---use-environment-activation-cache">`--use-environment-activation-cache`</a>
4747
: Use environment activation cache (experimental)
4848

49+
## Update Options
50+
- <a id="arg---no-install" href="#arg---no-install">`--no-install`</a>
51+
: Don't modify the environment, only modify the lock-file
52+
- <a id="arg---frozen" href="#arg---frozen">`--frozen`</a>
53+
: Install the environment as defined in the lockfile, doesn't update lockfile if it isn't up-to-date with the manifest file
54+
<br>**env**: `PIXI_FROZEN`
55+
- <a id="arg---locked" href="#arg---locked">`--locked`</a>
56+
: Check if lockfile is up-to-date before installing the environment, aborts when lockfile isn't up-to-date with the manifest file
57+
<br>**env**: `PIXI_LOCKED`
58+
- <a id="arg---as-is" href="#arg---as-is">`--as-is`</a>
59+
: Shorthand for the combination of --no-install and --frozen
60+
4961
## Global Options
5062
- <a id="arg---manifest-path" href="#arg---manifest-path">`--manifest-path <MANIFEST_PATH>`</a>
5163
: The path to `pixi.toml`, `pyproject.toml`, or the workspace directory

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# <code>[pixi](../pixi.md) list</code>
33

44
## About
5-
List workspace's packages
5+
List the packages of the current workspace
66

77
--8<-- "docs/reference/cli/pixi/list_extender:description"
88

@@ -46,7 +46,7 @@ pixi list [OPTIONS] [REGEX]
4646
: The path to `pixi.toml`, `pyproject.toml`, or the workspace directory
4747

4848
## Description
49-
List workspace's packages.
49+
List the packages of the current workspace
5050

5151
Highlighted packages are explicit dependencies.
5252

src/assets/pixi/reference/pixi_manifest.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1067,19 +1067,46 @@ The build system is a table that can contain the following fields:
10671067

10681068
- `source`: specifies the location of the source code for the package. Default: manifest directory. Currently supported options:
10691069
- `path`: a string representing a relative or absolute path to the source code.
1070+
- `git`: a string representing URL to the source repository.
1071+
- `rev`: a string representing SHA revision to checkout.
1072+
- `subdirectory`: a string representing path to subdirectory to use.
10701073
- `channels`: specifies the channels to get the build backend from.
10711074
- `backend`: specifies the build backend to use. This is a table that can contain the following fields:
10721075
- `name`: the name of the build backend to use. This will also be the executable name.
10731076
- `version`: the version of the build backend to use.
1074-
- `configuration`: a table that contains the configuration options for the build backend.
1077+
- `config`: a table that contains the configuration options for the build backend.
10751078
- `target`: a table that can contain target specific build configuration.
1079+
- Each target can have its own `config` table to override or extend the base configuration for specific platforms.
10761080

10771081
More documentation on the backends can be found in the [build backend documentation](../build/backends.md).
10781082

1083+
#### Basic build configuration example
1084+
10791085
```toml
10801086
--8<-- "docs/source_files/pixi_tomls/pixi-package-manifest.toml:build-system"
10811087
```
10821088

1089+
#### Target-specific build configuration example
1090+
1091+
For platform-specific build configuration, use the `[package.build.target.<platform>]` table:
1092+
1093+
```toml
1094+
[package.build]
1095+
backend = { name = "pixi-build-cmake", version = "0.3.*" }
1096+
1097+
[package.build.config]
1098+
# Base configuration applied to all platforms
1099+
extra-args = ["-DCMAKE_BUILD_TYPE=Release"]
1100+
1101+
[package.build.target.linux-64.config]
1102+
# Linux-specific configuration
1103+
extra-args = ["-DCMAKE_BUILD_TYPE=Debug", "-DLINUX_FLAG=ON"]
1104+
1105+
[package.build.target.win-64.config]
1106+
# Windows-specific configuration
1107+
extra-args = ["-DCMAKE_BUILD_TYPE=Debug", "-DWIN_FLAG=ON"]
1108+
```
1109+
10831110

10841111
### The `build` `host` and `run` dependencies tables
10851112
The dependencies of a package are split into three tables.

src/assets/pixi/tutorials/rust.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ compilation process.
124124
Make sure you also have the development packages of openssl installed.
125125
For example, `libssl-dev` on Ubuntu or `openssl-devel` on Fedora.
126126

127-
If you're in a situation where you think the directory *should* be found
127+
If you are in a situation where you think the directory *should* be found
128128
automatically, please open a bug at https://github.com/sfackler/rust-openssl
129129
and include information about your system as well as this message.
130130

@@ -133,7 +133,7 @@ $TARGET = x86_64-unknown-linux-gnu
133133
openssl-sys = 0.9.102
134134

135135

136-
It looks like you're compiling on Linux and also targeting Linux. Currently this
136+
It looks like you are compiling on Linux and also targeting Linux. Currently this
137137
requires the `pkg-config` utility to find OpenSSL but unfortunately `pkg-config`
138138
could not be found. If you have OpenSSL installed you can likely fix this by
139139
installing `pkg-config`.

0 commit comments

Comments
 (0)