README: running quak backup from cron, and its exit codes #170

Open
opened 2026-10-06 01:17:37 +02:00 by clawbot · 0 comments
Collaborator

Part of #162 (one cron-safe command that mirrors the whole account). Dispatched last, after #163, #164, #165, #166, #167, #168 and #169 land: it documents what they built.

What

The README shows how to run quak backup from cron and what each of its exit codes means.

Definition of done

  • A README section on running the backup from cron: log in once with quak login as the user the cron job runs as; a crontab example with a nightly quak backup <dir> and a weekly quak backup --verify <dir>, output appended to a log file; what cron's environment needs for quak to find the saved session (HOME, and XDG_DATA_HOME if it is set at login).
  • A table of quak backup's exit codes as the code on next gives them: 0, the backup is complete; 1, the run finished with files in failures.json or stopped on another error, and the next run tries again; 2, another backup of the same directory is running; 3, there is no usable session, so run quak login.
  • Every sentence matches the code on next; any README sentence the earlier units left stale is fixed.
  • A test pins each exit code of backupCommand if one is not already pinned.
  • TODO.md: an entry at the top of Completed Steps, and Next Step back to none open.

Touches README.md, TODO.md, maybe tests.

Model: opus-5-5

Part of https://git.eeqj.de/sneak/quak/issues/162 (one cron-safe command that mirrors the whole account). Dispatched last, after https://git.eeqj.de/sneak/quak/issues/163, https://git.eeqj.de/sneak/quak/issues/164, https://git.eeqj.de/sneak/quak/issues/165, https://git.eeqj.de/sneak/quak/issues/166, https://git.eeqj.de/sneak/quak/issues/167, https://git.eeqj.de/sneak/quak/issues/168 and https://git.eeqj.de/sneak/quak/issues/169 land: it documents what they built. ## What The README shows how to run `quak backup` from cron and what each of its exit codes means. ## Definition of done - A README section on running the backup from cron: log in once with `quak login` as the user the cron job runs as; a crontab example with a nightly `quak backup <dir>` and a weekly `quak backup --verify <dir>`, output appended to a log file; what cron's environment needs for quak to find the saved session (`HOME`, and `XDG_DATA_HOME` if it is set at login). - A table of `quak backup`'s exit codes as the code on `next` gives them: 0, the backup is complete; 1, the run finished with files in `failures.json` or stopped on another error, and the next run tries again; 2, another backup of the same directory is running; 3, there is no usable session, so run `quak login`. - Every sentence matches the code on `next`; any README sentence the earlier units left stale is fixed. - A test pins each exit code of `backupCommand` if one is not already pinned. - `TODO.md`: an entry at the top of Completed Steps, and Next Step back to none open. Touches `README.md`, `TODO.md`, maybe tests. Model: opus-5-5
clawbot self-assigned this 2026-10-06 01:17:37 +02:00
Sign in to join this conversation.