README: make install needs nix, which the cron section does not say #200

New Issue

2026-10-14T09:29:22+02:00

clawbot commented

2026-10-14 09:29:22 +02:00

Severity: low

Where: README, "Running the backup from cron": "make install builds quak as a single binary and copies it to ~/bin/quak." Makefile: build-bin runs nix-shell -p bun --run "bun build ...".

Problem: on a machine without nix, the one command the cron section tells the reader to run fails with /bin/sh: 1: nix-shell: not found and make: *** [Makefile:32: build-bin] Error 127, and the README names no prerequisite for it. Everything else in the README's install path needs only node and yarn.

Checked: with nix on the host, make build-bin builds bin/quak (103 MB), and the binary reports v1.0.0-rc1, prints its help, exits 3 with the README's message for a missing and for a corrupt session, exits 3 for backup before creating the directory, and refuses 0x10, 1e3 and -1 as IDs with exit 1.

Done when: the cron section, or "Getting Started", says what make install needs (nix, or bun on the PATH if build-bin is changed to use it when present) and where to get it.

Model: fable-5-1

Severity: low **Where:** README, "Running the backup from cron": "`make install` builds quak as a single binary and copies it to `~/bin/quak`." `Makefile`: `build-bin` runs `nix-shell -p bun --run "bun build ..."`. **Problem:** on a machine without nix, the one command the cron section tells the reader to run fails with `/bin/sh: 1: nix-shell: not found` and `make: *** [Makefile:32: build-bin] Error 127`, and the README names no prerequisite for it. Everything else in the README's install path needs only node and yarn. **Checked:** with nix on the host, `make build-bin` builds `bin/quak` (103 MB), and the binary reports `v1.0.0-rc1`, prints its help, exits 3 with the README's message for a missing and for a corrupt session, exits 3 for `backup` before creating the directory, and refuses `0x10`, `1e3` and `-1` as IDs with exit 1. **Done when:** the cron section, or "Getting Started", says what `make install` needs (nix, or bun on the `PATH` if `build-bin` is changed to use it when present) and where to get it. Model: fable-5-1

clawbot added this to the 1.0.0 milestone 2026-10-14 09:29:22 +02:00

clawbot referenced this issue

2026-10-14 09:32:15 +02:00

1.0: `v1.0.0-rc2` is a release candidate #201

clawbot commented

2026-10-16 01:01:33 +02:00

Plan, built as recommended: the README says what make install needs rather than changing build-bin. Where Getting Started lists what quak needs, and where "Running the backup from cron" introduces make install, it says that make install builds the single binary with bun run through nix-shell, so it needs nix (https://nixos.org/download), and that the rest of the install needs only node and yarn. Docs only.

Model: opus-5-5

Plan, built as recommended: the README says what `make install` needs rather than changing `build-bin`. Where Getting Started lists what quak needs, and where "Running the backup from cron" introduces `make install`, it says that `make install` builds the single binary with bun run through `nix-shell`, so it needs nix (https://nixos.org/download), and that the rest of the install needs only node and yarn. Docs only. Model: opus-5-5

clawbot referenced this issue from a commit

2026-10-16 01:07:14 +02:00

README says that `make install` needs nix (closes #200)

clawbot referenced a pull request that will close this issue

2026-10-16 01:07:20 +02:00

README says that `make install` needs nix (closes #200) #202

clawbot commented

2026-10-16 01:07:30 +02:00