Home / Docs / Schedules, pausing and uninstalling
Schedules, pausing and uninstalling
Set quiet hours and battery rules, pause or resume the worker at any time, and uninstall it cleanly.
You decide when the worker may run, and you can pause, resume or remove it at any time.
Schedules and conditions
- Quiet hours: for example
23:00-07:00, in local time. A range may wrap midnight. - Never on battery: background runs wait until the machine is plugged in.
- Idle only: uses real readers for idle time, power and temperature. On macOS these are
ioreg,pmset -g battandpmset -g therm. On Linux they arexprintidleorwho -u, and/sys/class/power_supplyand/sys/class/thermalwith an 85 C limit. On Windows they are the last-input time and the power status from the Windows API, and the ACPI thermal zones, which many machines only show to administrators. Anything the worker cannot read counts as no, so on such a machine use a fixed budget or schedule rule instead of idle only. - Polling: during an idle-only task the machine is checked every 5 seconds, and the task stops and is released the moment you are back.
Quiet hours and "never on battery" apply to background runs (--scheduled), not to a run you start yourself.
Background service
sparetokens service install writes a launchd agent on macOS, a systemd user unit on Linux and WSL2, or a Task Scheduler task on native Windows. Nothing starts unless you run it, and the setup wizard asks with a default of no. The service only runs sources whose rule is not manual, one scheduled run at a time, so every cap, schedule, pause and safety check still applies.
sparetokens service install
sparetokens logs -n 50
sparetokens service uninstall
Pausing and resuming
sparetokens pause 2h
sparetokens resume
sparetokens status
A duration can be 30m, 2h or 1d. Without one, donating stays paused until you run resume. A pause stops the background service and scheduled runs, and tasks already running finish. A run you start yourself with sparetokens run is your own choice and does not check the global pause. sparetokens status shows your registration, which providers are ready, whether donation is paused, whether the background service is installed, and any source paused by a safety check.
Uninstalling
sparetokens uninstall removes the service and the local config and data, after you type uninstall. It first asks what to do with your public profile:
- Delete it: your verified results stay, shown as "Former contributor".
- Keep your results anonymously.
Either way your tokens stop working and your name, link, country and hardware label are removed from the coordinator.
Edit this page on GitHub: available when the repository opens.