topgrade 17.6.2

Upgrade all the things

Introduction

[!NOTE] This is a fork of topgrade by r-darwish to keep it maintained.

Keeping your system up-to-date usually involves invoking multiple package managers. This results in big, non-portable shell one-liners saved in your shell. To remedy this, Topgrade detects which tools you use and runs the appropriate commands to update them.

Installation

Official

• Self-updating binary (all platforms): releases
• Install from source (all platforms): cargo install topgrade
• Debian/Ubuntu (deb-get): deb-get install topgrade
• Arch Linux (AUR): topgrade or topgrade-bin
• PyPi: pip, pipx, or uv tool install topgrade
• Windows (Winget): winget install --id=topgrade-rs.topgrade -e
• macOS or Linux (Homebrew): brew install topgrade
• Fedora/RHEL/AlmaLinux/CentOS-Stream (Copr): sudo dnf copr enable lilay/topgrade && sudo dnf install topgrade

Community-maintained

• Windows (Chocolatey): choco install topgrade
• Windows (Scoop): scoop bucket add main && scoop install main/topgrade
• macOS (MacPorts): sudo port install topgrade
• Ubuntu (Pacstall): pacstall -I topgrade-bin
• NixOS or Nix (nixpkgs): topgrade
• Alpine Linux: sudo apk add topgrade
• Void Linux: sudo xbps-install -S topgrade

Usage

Just run topgrade.

Configuration

See config.example.toml for an example configuration file.

MSRV

Find the current MSRV in Cargo.toml under rust-version. This MSRV will only be bumped in a major release.

Migration and Breaking Changes

Whenever there is a breaking change, the major version number will be bumped, and we will document these changes in the release note, please take a look at it when updated to a major release.

Got a question? Feel free to open an issue or discussion!

Configuration Path

CONFIG_DIR on each platform

• Windows: %APPDATA%
• macOS and other Unix systems: ${XDG_CONFIG_HOME:-~/.config}

topgrade will look for the configuration file in the following places, in order of priority:

1. CONFIG_DIR/topgrade.toml
2. CONFIG_DIR/topgrade/topgrade.toml

If the file with higher priority is present, no matter if it is valid or not, the other configuration files will be ignored.

On the first run (provided that no configuration file exists), topgrade will create a configuration file at CONFIG_DIR/topgrade.toml for you.

Custom Commands

Custom commands can be defined in the configuration file, which can be run before, during, or after the inbuilt commands, as required. By default, the custom commands are run using a new shell according to the $SHELL environment variable on Unix (falls back to sh) or pwsh on Windows (falls back to powershell).

On Unix, if you want to run your command using an interactive shell, for example to source your shell's RC files, you can add -i at the start of your custom command. Although note that this requires the command to exit the shell correctly, or else the shell will hang indefinitely.

Remote Execution

You can specify a key called remote_topgrades in the configuration file. This key should contain a list of hostnames that have Topgrade installed on them. Topgrade will use ssh to run topgrade on remote hosts before acting locally. To limit the execution only to specific hosts use the --remote-host-limit parameter.

Contribution

Problems or missing features?

Open a new issue describing your problem and if possible provide a solution.

Missing a feature or found an unsupported tool/distro?

Just let us now what you are missing by opening an issue. For tools, please open an issue describing the tool, which platforms it supports and if possible, give us an example of its usage.

Want to contribute?

See CONTRIBUTING.md

Discord server

You're welcome to join our Discord server if you want to discuss Topgrade!