Documentation & Modules

CLI usage, shell completion setup, configuration directives, and the complete registry of 59 supported update sources.

Installation Methods

1. Homebrew (Recommended)recommended

Install via official Homebrew tap. SystemUpdater and its formulae are updated automatically by Homebrew.

bash
brew tap Piotrunius/tap
brew trust Piotrunius/tap
brew install systemupdater
2. Git Checkoutstandalone

Links ~/.local/bin/sysupdate and auto-creates default config. The checkout auto-updates itself when run.

bash
git clone https://github.com/Piotrunius/SystemUpdater.git ~/.local/share/sysupdate
cd ~/.local/share/sysupdate
./install.sh
Native Shell Completions

Generates tab completions for flags, categories, and module keys:

bash / zsh / fish
# Auto-detect installed shells and register completions
sysupdate --generate-completion

# Or specify your shell directly
sysupdate --generate-completion zsh

Command-Line Options

sysupdate [flags]
FlagCategoryDescription
--help, -hGeneralShow help message and exit
--versionGeneralShow installed version and check for latest available release
-q, --quietOutputSuppress live step progress; show only final summary and errors
-v, --verboseOutputStream update command output live; keep internal probes quiet
--notifyExecutionSend native desktop notification on completion (Linux notify-send / macOS osascript)
--no-sudoExecutionSkip all modules requiring administrator (sudo) privileges
--no-snapshotProtectionSkip protective Btrfs snapshot creation before update
-f, --forceProtectionForce execution (e.g. bypass Btrfs snapshot cooldown)
--only <modules>FilteringComma-separated module keys or aliases to run (e.g. 'dnf,brew')
--skip <modules>FilteringComma-separated module keys to skip
-c, --category <names>FilteringComma-separated categories to run (e.g. 'system', 'dev')
-l, --listDiscoveryList all registered modules and check their system availability
--history [COUNT]HistoryList recent update runs (default: 10, maximum: 30)
--show-log <ID>HistoryShow saved command output for a run listed by --history
--no-historyHistoryDo not record this run or its command logs in history
-r, --rebootExecutionReboot system after update if required by kernel or firmware
--generate-completion [SHELL]GeneralInstall shell completions for bash, zsh, or fish
--edit-configConfigurationOpen configuration file in $EDITOR
--config <PATH>ConfigurationPath to custom configuration TOML file

Configuration Directives

[misc]

Snapper root snapshot cooldown hours and maximum command execution timeout.

[behavior]

Quiet mode, verbose streaming, no-sudo, and reboot automation.

[notifications]

Desktop notification triggers (Linux notify-send, macOS osascript).

[modules]

Permanently disabled modules, default skipped keys, or strict inclusion lists.

[git]

Local git repositories to pull and update during the run.

[pre/post_commands]

Arbitrary shell commands executed before or after update passes.

Supported Update Modules

Tools are automatically detected at runtime. Run sysupdate --list to inspect which modules are active on your current machine.

59 of 59 modules
ToolKeyCategoryPrivilegesPlatformDescription
Snapper Btrfs SnapshotssnapshotSystem ProtectionsudolinuxCreates a protective Btrfs root snapshot via Snapper before updates
Nobara RepositoriesreposyncSystem CoresudolinuxSynchronizes Nobara repository configs, GPG keys, and updater packages
DNF / RPMsystemSystem CoresudolinuxPerforms full DNF system package upgrade
APTaptSystem CoresudolinuxUpdates system packages via APT
Pacman & AURpacmanSystem CoresudolinuxUpdates system and AUR packages via Pacman / Yay / Paru
ZypperzypperSystem CoresudolinuxUpdates system packages via Zypper
APKapkSystem CoresudolinuxUpdates system packages via APK
XBPSxbpsSystem CoresudolinuxUpdates system packages via XBPS
macOS Software UpdatemacosSystem CoresudomacosUpdates system software and developer tools via softwareupdate
FirmwarefirmwareSystem CoreuserlinuxChecks and applies hardware/UEFI firmware updates via fwupdmgr
FlatpakflatpakApplications & GaminguserlinuxUpdates user and system Flatpak applications and runtimes
Nuvio DesktopnuvioApplications & GamingsudolinuxChecks GitHub releases for Nuvio, installs RPM, and applies Coil3 Linux image patch
Gear LevergearleverApplications & GaminguserlinuxChecks and fetches appimage updates via Gear Lever
ProtonPlusprotonApplications & GaminguserlinuxUpdates compatibility tools like Proton-GE, CachyOS, and Wine via ProtonPlus
DistroboxdistroboxApplications & GaminguserlinuxUpgrades packages inside all active Distrobox containers across distributions
App StoremasApplications & GamingusermacosUpdates Mac App Store applications via mas
HomebrewbrewContainers & PackagesuseruniversalUpdates Homebrew taps, formulae, and desktop casks
DockerdockerContainers & PackagesuseruniversalPulls latest versions of all locally tracked Docker container images
PodmanpodmanContainers & PackagesuseruniversalUpdates containers using podman auto-update
VagrantvagrantContainers & PackagesuseruniversalChecks and updates installed Vagrant boxes
SnapsnapContainers & PackagessudolinuxUpdates installed Snap packages via snap refresh
NixnixContainers & PackagesuseruniversalUpdates Nix package channels and user environment
ChezmoichezmoiDevelopment EnvironmentuseruniversalUpdates managed dotfiles via chezmoi update
YadmyadmDevelopment EnvironmentuseruniversalUpdates dotfiles via yadm pull
Oh My ZshomzDevelopment EnvironmentuseruniversalUpdates Oh My Zsh framework
ZinitzinitDevelopment EnvironmentuseruniversalUpdates Zsh plugins via Zinit
FisherfisherDevelopment EnvironmentuseruniversalUpdates Fish shell plugins via Fisher
TealdeertldrDevelopment EnvironmentuseruniversalUpdates offline tldr pages database via tealdeer
RustrustupDevelopment EnvironmentuseruniversalUpdates Rust compiler toolchains and rustup itself
CargocargoDevelopment EnvironmentuseruniversalUpdates installed cargo crates via cargo-update
PippipDevelopment EnvironmentuseruniversalUpgrades pip user installation to the latest version
uvuvDevelopment EnvironmentuseruniversalUpdates uv executable and all installed uv tools
PipxpipxDevelopment EnvironmentuseruniversalUpdates all pipx-installed CLI applications
PipenvpipenvDevelopment EnvironmentuseruniversalUpdates pipenv packaging tool
PoetrypoetryDevelopment EnvironmentuseruniversalUpdates Poetry packaging tool
CondacondaDevelopment EnvironmentuseruniversalUpdates Conda base environment packages
pyenvpyenvDevelopment EnvironmentuseruniversalUpdates pyenv and python definitions via pyenv update
NpmnpmDevelopment EnvironmentuseruniversalUpdates globally installed Node.js npm packages
PnpmpnpmDevelopment EnvironmentuseruniversalUpdates globally installed pnpm packages
BunbunDevelopment EnvironmentuseruniversalUpdates globally installed Bun packages
YarnyarnDevelopment EnvironmentuseruniversalUpdates globally installed Yarn packages
ComposercomposerDevelopment EnvironmentuseruniversalUpdates Composer executable and global dependencies
RubygemDevelopment EnvironmentuseruniversalUpdates RubyGems system and installed gems
MisemiseDevelopment EnvironmentuseruniversalUpdates mise CLI and installed dev toolchains
asdfasdfDevelopment EnvironmentuseruniversalUpdates asdf version manager plugins
SDKMANsdkmanDevelopment EnvironmentuseruniversalUpdates SDKMAN tool and installed candidate versions
GHCupghcupDevelopment EnvironmentuseruniversalUpdates Haskell GHCup toolchain manager
FlutterflutterDevelopment EnvironmentuseruniversalUpdates Flutter SDK toolchain
NeovimneovimDevelopment EnvironmentuseruniversalUpdates Neovim plugins via Lazy.nvim
MicromicroDevelopment EnvironmentuseruniversalUpdates plugins installed in the Micro text editor
HelixhelixDevelopment EnvironmentuseruniversalUpdates Helix editor tree-sitter grammars
VS CodevscodeDevelopment EnvironmentuseruniversalUpdates installed VS Code extensions
CursorcursorDevelopment EnvironmentuseruniversalUpdates installed Cursor extensions
VSCodiumcodiumDevelopment EnvironmentuseruniversalUpdates installed VSCodium extensions
TmuxtmuxDevelopment EnvironmentuseruniversalUpdates tmux plugins via TPM
GitHub CLIghDevelopment EnvironmentuseruniversalUpdates installed GitHub CLI extensions
AgentsskillsDevelopment EnvironmentuseruniversalUpdates global Agent Skills via npx skills
AntigravityantigravityDevelopment EnvironmentuseruniversalUpdates Antigravity extensions
GitgitDevelopment EnvironmentuseruniversalPulls latest commits for repositories configured in config.toml