# agentic Nix packages for third-party tools that don't ship their own flakes. ## Layout ``` flake.nix # flake entrypoint: exposes packages.* and apps.* flake.lock packages/ vit/ # one directory per package (callPackage style) default.nix package-lock.json # only when we need a fixed/regenerated lock upstream.json # how CI discovers and bumps this package scripts/ update-packages.sh # version bump + hash/lock refresh .github/workflows/ update-packages.yml # weekly cron + manual dispatch ``` Add a new package by creating `packages//default.nix` and wiring it in `flake.nix` via `pkgs.callPackage ./packages/ { }`. For automated updates, also add `packages//upstream.json` (see below). ## Packages | Attr | Upstream | Install (non-Nix) | |------|----------|-------------------| | `vit` | [solpbc/vit](https://github.com/solpbc/vit) | `npm install -g vit` | | `rook` | [solpbc/rook](https://github.com/solpbc/rook) | `npm install -g @solpbc/rook` | | `spinel` | [matz/spinel](https://github.com/matz/spinel) | build from source (`make deps && make && make install`) | ## Usage ```bash # build nix build .#vit nix build .#rook nix build .#spinel # run without installing nix run .#vit -- --help nix run .#rook -- --help nix run .#spinel -- --help nix run .#spin -- new myapp # spin project tool (from the spinel package) # install into your profile nix profile install .#vit nix profile install .#rook nix profile install .#spinel ``` ## Updating packages ### Automated (recommended) A GitHub Action runs **every Monday** (and on manual dispatch) to: 1. Read each `packages/*/upstream.json` 2. Compare the packaged version to the latest upstream tag 3. Refresh source hashes, regenerate lockfiles when needed, recompute `npmDepsHash` 4. Verify `nix build .#` 5. Open a PR on branch `chore/update-packages` if anything changed ```bash # local dry-run: exit 1 if any package is behind upstream ./scripts/update-packages.sh --check # apply updates locally (requires nix, curl, npm) ./scripts/update-packages.sh # all packages ./scripts/update-packages.sh vit # one package ``` ### `upstream.json` Supported types: **npm-github** — tagged npm projects: ```json { "type": "npm-github", "github": "owner/repo", "tag_prefix": "v" } ``` `npm-github` packages are expected to use `buildNpmPackage` + `fetchFromGitHub` with a `version` field and optional vendored `package-lock.json`. **github-unstable** — projects without release tags (track branch tip): ```json { "type": "github-unstable", "github": "owner/repo", "branch": "master" } ``` Versions are `0-unstable-YYYY-MM-DD` with a pinned `rev` in `fetchFromGitHub`. For spinel, the updater also re-reads `PRISM_VERSION` / `RBS_VERSION` from the upstream Makefile and refreshes the vendored gem hashes when they change. ### Manual steps (vit / rook) If you prefer to bump by hand (same flow for either npm-github package): 1. Bump `version` in `packages//default.nix`. 2. Prefetch the new source hash: ```bash nix-prefetch-url --unpack "https://github.com/solpbc//archive/refs/tags/vX.Y.Z.tar.gz" nix hash convert --hash-algo sha256 --to sri ``` 3. Regenerate a lockfile with resolved URLs when needed: ```bash tmp=$(mktemp -d) && cd "$tmp" curl -sL "https://github.com/solpbc//archive/refs/tags/vX.Y.Z.tar.gz" | tar -xz cd -X.Y.Z rm -f package-lock.json bun.lock npm install --package-lock-only --ignore-scripts cp package-lock.json /path/to/this/repo/packages//package-lock.json ``` 4. Set `npmDepsHash` to the all-zero fake hash, run `nix build .#`, paste the hash nix prints as `got:`, rebuild. Or just run `./scripts/update-packages.sh vit` / `./scripts/update-packages.sh rook`. ### Manual steps (spinel) Spinel has no release tags yet, so the package pins a git commit as `0-unstable-YYYY-MM-DD`. Prefer the updater: ```bash ./scripts/update-packages.sh spinel ``` By hand: 1. Bump `version`, `rev`, and the `fetchFromGitHub` `hash` in `packages/spinel/default.nix`. 2. If upstream changed `PRISM_VERSION` / `RBS_VERSION` in its Makefile, update `prismVersion` / `rbsVersion` and re-hash the gems: ```bash nix-prefetch-url "https://rubygems.org/gems/prism-X.Y.Z.gem" nix-prefetch-url "https://rubygems.org/gems/rbs-X.Y.Z.gem" nix hash convert --hash-algo sha256 --to sri ``` 3. `nix build .#spinel` and smoke-test `./result/bin/spinel -e 'puts 1'`.