An experimental spindle with support for Pixi as an engine
docs: add setup/example
Ethan Holz
(May 22, 2026, 11:47 AM -0600)
625505a4
7ec7dd77
+43
-4
+4
-2
.tangled/workflows/ci.yaml
+4
-2
.tangled/workflows/ci.yaml
+37
-2
README.md
+37
-2
README.md
···
1
1
# pixi-spindle [WIP]
2
2
3
-
The purpose of this repo is to explore using [`pixi`](https://pixi.prefix.dev/latest/) as an alternative to Nixery for a Tangled Spindle.
3
+
The purpose of this repo is to explore using [`pixi`](https://pixi.prefix.dev/latest/) as an
4
+
alternative to Nixery for a Tangled Spindle.
4
5
This reuses most of the harness from the default spindle.
5
6
7
+
## Goal
8
+
Use pixi environments as the source of truth CI environments
9
+
and lean on `pixi run` (which uses [`deno_task_shell`](https://github.com/denoland/deno_task_shell) under the hood).
10
+
This approach makes it so that you can actually run your tests locally because the pipeline can be completely encoded
11
+
into your `pixi.toml` or `pyproject.toml` file.
12
+
13
+
## Example
14
+
The following example is for the current repo:
15
+
```yaml
16
+
when:
17
+
- event: ["push", "manual"]
18
+
branch: ["main"]
19
+
20
+
engine: "pixi"
21
+
22
+
pixi:
23
+
# This install from the default pixi environment
24
+
environment: "default"
25
+
26
+
clone:
27
+
skip: false
28
+
depth: 1
29
+
submodules: false
30
+
31
+
steps:
32
+
- name: "Test"
33
+
# This runs "pixi run test" under the hood
34
+
command: "test"
35
+
- name: "Build"
36
+
# This runs "pixi run build" under the hood
37
+
command: "build"
38
+
```
39
+
6
40
## Development Setup
7
41
8
42
### Requirements
···
13
47
2. Run `pixi run go build` to build
14
48
15
49
## TODOs
16
-
- [ ] Add setup instructions
50
+
- [x] Add setup instructions
17
51
- [ ] Add systemd unit
18
52
- [ ] Add configurable memory limit
19
53
- [ ] Test manual, global dependencies
···
23
57
24
58
### Optional
25
59
- [ ] Consider building a minimal custom Pixi image with Git installed
60
+
- [ ] Add a script to easily add support to a repo
26
61