Documentation & Modules
CLI usage, shell completion setup, configuration directives, and the complete registry of 59 supported update sources.
Installation Methods
Install via official Homebrew tap. SystemUpdater and its formulae are updated automatically by Homebrew.
brew tap Piotrunius/tap
brew trust Piotrunius/tap
brew install systemupdaterLinks ~/.local/bin/sysupdate and auto-creates default config. The checkout auto-updates itself when run.
git clone https://github.com/Piotrunius/SystemUpdater.git ~/.local/share/sysupdate
cd ~/.local/share/sysupdate
./install.shGenerates tab completions for flags, categories, and module keys:
# Auto-detect installed shells and register completions
sysupdate --generate-completion
# Or specify your shell directly
sysupdate --generate-completion zshCommand-Line Options
sysupdate [flags]| Flag | Category | Description |
|---|---|---|
| --help, -h | General | Show help message and exit |
| --version | General | Show installed version and check for latest available release |
| -q, --quiet | Output | Suppress live step progress; show only final summary and errors |
| -v, --verbose | Output | Stream update command output live; keep internal probes quiet |
| --notify | Execution | Send native desktop notification on completion (Linux notify-send / macOS osascript) |
| --no-sudo | Execution | Skip all modules requiring administrator (sudo) privileges |
| --no-snapshot | Protection | Skip protective Btrfs snapshot creation before update |
| -f, --force | Protection | Force execution (e.g. bypass Btrfs snapshot cooldown) |
| --only <modules> | Filtering | Comma-separated module keys or aliases to run (e.g. 'dnf,brew') |
| --skip <modules> | Filtering | Comma-separated module keys to skip |
| -c, --category <names> | Filtering | Comma-separated categories to run (e.g. 'system', 'dev') |
| -l, --list | Discovery | List all registered modules and check their system availability |
| --history [COUNT] | History | List recent update runs (default: 10, maximum: 30) |
| --show-log <ID> | History | Show saved command output for a run listed by --history |
| --no-history | History | Do not record this run or its command logs in history |
| -r, --reboot | Execution | Reboot system after update if required by kernel or firmware |
| --generate-completion [SHELL] | General | Install shell completions for bash, zsh, or fish |
| --edit-config | Configuration | Open configuration file in $EDITOR |
| --config <PATH> | Configuration | Path 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.
| Tool | Key | Category | Privileges | Platform | Description |
|---|---|---|---|---|---|
| Snapper Btrfs Snapshots | snapshot | System Protection | sudo | linux | Creates a protective Btrfs root snapshot via Snapper before updates |
| Nobara Repositories | reposync | System Core | sudo | linux | Synchronizes Nobara repository configs, GPG keys, and updater packages |
| DNF / RPM | system | System Core | sudo | linux | Performs full DNF system package upgrade |
| APT | apt | System Core | sudo | linux | Updates system packages via APT |
| Pacman & AUR | pacman | System Core | sudo | linux | Updates system and AUR packages via Pacman / Yay / Paru |
| Zypper | zypper | System Core | sudo | linux | Updates system packages via Zypper |
| APK | apk | System Core | sudo | linux | Updates system packages via APK |
| XBPS | xbps | System Core | sudo | linux | Updates system packages via XBPS |
| macOS Software Update | macos | System Core | sudo | macos | Updates system software and developer tools via softwareupdate |
| Firmware | firmware | System Core | user | linux | Checks and applies hardware/UEFI firmware updates via fwupdmgr |
| Flatpak | flatpak | Applications & Gaming | user | linux | Updates user and system Flatpak applications and runtimes |
| Nuvio Desktop | nuvio | Applications & Gaming | sudo | linux | Checks GitHub releases for Nuvio, installs RPM, and applies Coil3 Linux image patch |
| Gear Lever | gearlever | Applications & Gaming | user | linux | Checks and fetches appimage updates via Gear Lever |
| ProtonPlus | proton | Applications & Gaming | user | linux | Updates compatibility tools like Proton-GE, CachyOS, and Wine via ProtonPlus |
| Distrobox | distrobox | Applications & Gaming | user | linux | Upgrades packages inside all active Distrobox containers across distributions |
| App Store | mas | Applications & Gaming | user | macos | Updates Mac App Store applications via mas |
| Homebrew | brew | Containers & Packages | user | universal | Updates Homebrew taps, formulae, and desktop casks |
| Docker | docker | Containers & Packages | user | universal | Pulls latest versions of all locally tracked Docker container images |
| Podman | podman | Containers & Packages | user | universal | Updates containers using podman auto-update |
| Vagrant | vagrant | Containers & Packages | user | universal | Checks and updates installed Vagrant boxes |
| Snap | snap | Containers & Packages | sudo | linux | Updates installed Snap packages via snap refresh |
| Nix | nix | Containers & Packages | user | universal | Updates Nix package channels and user environment |
| Chezmoi | chezmoi | Development Environment | user | universal | Updates managed dotfiles via chezmoi update |
| Yadm | yadm | Development Environment | user | universal | Updates dotfiles via yadm pull |
| Oh My Zsh | omz | Development Environment | user | universal | Updates Oh My Zsh framework |
| Zinit | zinit | Development Environment | user | universal | Updates Zsh plugins via Zinit |
| Fisher | fisher | Development Environment | user | universal | Updates Fish shell plugins via Fisher |
| Tealdeer | tldr | Development Environment | user | universal | Updates offline tldr pages database via tealdeer |
| Rust | rustup | Development Environment | user | universal | Updates Rust compiler toolchains and rustup itself |
| Cargo | cargo | Development Environment | user | universal | Updates installed cargo crates via cargo-update |
| Pip | pip | Development Environment | user | universal | Upgrades pip user installation to the latest version |
| uv | uv | Development Environment | user | universal | Updates uv executable and all installed uv tools |
| Pipx | pipx | Development Environment | user | universal | Updates all pipx-installed CLI applications |
| Pipenv | pipenv | Development Environment | user | universal | Updates pipenv packaging tool |
| Poetry | poetry | Development Environment | user | universal | Updates Poetry packaging tool |
| Conda | conda | Development Environment | user | universal | Updates Conda base environment packages |
| pyenv | pyenv | Development Environment | user | universal | Updates pyenv and python definitions via pyenv update |
| Npm | npm | Development Environment | user | universal | Updates globally installed Node.js npm packages |
| Pnpm | pnpm | Development Environment | user | universal | Updates globally installed pnpm packages |
| Bun | bun | Development Environment | user | universal | Updates globally installed Bun packages |
| Yarn | yarn | Development Environment | user | universal | Updates globally installed Yarn packages |
| Composer | composer | Development Environment | user | universal | Updates Composer executable and global dependencies |
| Ruby | gem | Development Environment | user | universal | Updates RubyGems system and installed gems |
| Mise | mise | Development Environment | user | universal | Updates mise CLI and installed dev toolchains |
| asdf | asdf | Development Environment | user | universal | Updates asdf version manager plugins |
| SDKMAN | sdkman | Development Environment | user | universal | Updates SDKMAN tool and installed candidate versions |
| GHCup | ghcup | Development Environment | user | universal | Updates Haskell GHCup toolchain manager |
| Flutter | flutter | Development Environment | user | universal | Updates Flutter SDK toolchain |
| Neovim | neovim | Development Environment | user | universal | Updates Neovim plugins via Lazy.nvim |
| Micro | micro | Development Environment | user | universal | Updates plugins installed in the Micro text editor |
| Helix | helix | Development Environment | user | universal | Updates Helix editor tree-sitter grammars |
| VS Code | vscode | Development Environment | user | universal | Updates installed VS Code extensions |
| Cursor | cursor | Development Environment | user | universal | Updates installed Cursor extensions |
| VSCodium | codium | Development Environment | user | universal | Updates installed VSCodium extensions |
| Tmux | tmux | Development Environment | user | universal | Updates tmux plugins via TPM |
| GitHub CLI | gh | Development Environment | user | universal | Updates installed GitHub CLI extensions |
| Agents | skills | Development Environment | user | universal | Updates global Agent Skills via npx skills |
| Antigravity | antigravity | Development Environment | user | universal | Updates Antigravity extensions |
| Git | git | Development Environment | user | universal | Pulls latest commits for repositories configured in config.toml |