From 7cd6eafafe6451a59ffb791ef66389fc6940e83f Mon Sep 17 00:00:00 2001 From: Felitendo Date: Thu, 24 Sep 2026 02:00:35 +0200 Subject: [PATCH] docs: cut the readme down, fold the details --- README.md | 99 ++++++++++++++++++++++++++----------------------------- 1 file changed, 46 insertions(+), 53 deletions(-) diff --git a/README.md b/README.md index 7d84308..28b3c12 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,12 @@

Unattended background updates for CachyOS.

- Supports pacman, AUR, Flatpak and AppImages. + pacman, AUR, Flatpak and AppImages. In the background, with no password prompt.

- How to use | Install | + How to use | Report a bug
@@ -20,11 +20,6 @@ Buy Me A Coffee

-Built for the machine you set up for somebody else and would rather not maintain. -Stays out of the way while they are gaming or on battery, never touches the -package database while `pacman` is already running, and only bothers you if something -went wrong. - ## Install ```bash @@ -32,9 +27,7 @@ paru -S cachy-auto-update sudo cachy-auto-update enable ``` -Updates are **off** until you enable them. - -## Usage +## How to use ```bash sudo cachy-auto-update @@ -44,54 +37,65 @@ sudo cachy-auto-update The cachy-auto-update menu in Konsole: automatic updates and notifications on

-Everything is configurable from **[6] Settings**. -The interface is also translated to German (more langs coming soon (maybe)). +Press **1** to turn automatic updates on or off. **6** has all the settings. -## What it updates +## When does it update? | | | |---|---| -| Repository packages | `pacman -Syu` | -| AUR | `paru` or `yay`, whichever is installed | -| Flatpak | system and per-user installations | -| AppImages | via [Gear Lever](https://github.com/mijorus/gearlever), if installed | +| Battery below 30 % | ⏸️ Waits (on power it runs) | +| A game is running | ⏸️ Waits | +| pacman, yay or paru is running | ⏸️ Waits | +| Shutdown or suspend during an update | 🚫 Blocked until it is done | +| Restart after an update | ❌ Never on its own, you get a notification | +## More -## When it doesn't update +
+What it updates -A run is postponed (retried an hour later) when: +| | | +|---|---| +| Packages | `pacman -Syu` | +| AUR | `paru` or `yay` | +| Flatpak | system and user installs | +| AppImages | through [Gear Lever](https://github.com/mijorus/gearlever) | -- battery is below 30 % (ignored on mains power), -- a game is running, -- pacman's database is locked or another package manager is running. +
-The machine will obviously **never** automatically restart (this is not windows) +
+Safety -## Safety measures +- A progress bar shows the step and the package. +- On Btrfs with snapper (the CachyOS default) every update gets a snapshot before and after. +- A lock file left by a power cut is removed on the next run. +- Package replacements are handled on their own. File conflicts are never overwritten. +- A signature error refreshes the keyring once and tries again. -- A **progress bar** shows which step is running and which package is being updated. -- **Suspend and shutdown are blocked** via `systemd-inhibit` during updates. -- A `db.lck` left by a crash is removed on the next run. -- On Btrfs with `snapper`/`snap-pac` (the CachyOS default), every transaction - gets a pre/post snapshot. +
-## Package conflicts - -`AutoResolveConflicts=yes` (default) retries conflicting package replacements -automatically. - -File conflicts (`exists in filesystem`) are **not** force-overwritten. -Signature failures trigger one keyring refresh and one retry. - -## Logs +
+Logs ```bash cachy-auto-update log # last run -cachy-auto-update log -a # rolling log +cachy-auto-update log -a # all runs journalctl -u cachy-auto-update ``` -## Building from source +
+ +
+cachy-update + +[cachy-update](https://github.com/CachyOS/cachy-update) tells you about updates, you install them. +This installs them for you. Both work side by side, and `enable` offers to silence +cachy-update's notification. + +
+ +
+Build from source ```bash make && sudo make install @@ -99,19 +103,8 @@ sudo systemd-sysusers && sudo systemd-tmpfiles --create sudo cachy-auto-update enable ``` -`make check` runs shellcheck, syntax checks, and validates the sudoers drop-in. +Optional: `pacman-contrib`, an AUR helper, `flatpak`, Gear Lever, `libnotify`, `python-gobject`. -Optional runtime dependencies (degrades gracefully without them): -`pacman-contrib`, an AUR helper, `flatpak`, Gear Lever, `libnotify`, -`python-gobject`. - -## Relationship to cachy-update - -[cachy-update](https://github.com/CachyOS/cachy-update) is CachyOS's -interactive updater which checks for updates and notifies, but that needs manual intervention. -This is the unattended counterpart. The two can coexist; `enable` offers -to switch off cachy-update's notification since it becomes obsolete. - -## License +
GPL-3.0-or-later.