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.

• Arch Linux: AUR
• NixOS: Nixpkgs
• Void Linux: XBPS
• macOS: Homebrew or MacPorts
• Windows: Scoop

Other systems users can either use cargo install or the compiled binaries from the release page. The compiled binaries contain a self-upgrading feature.

Topgrade requires Rust 1.60 or above.

Just run topgrade.

Visit the documentation at topgrade-rs.github.io for more information.

Warning Work in Progress

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

The configuration should be placed in the following paths depending on the operating system:

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

Custom commands can be defined in the config 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. But note that this requires the command to exit the shell correctly or else the shell will hang indefinitely.

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.

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

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.

Just fork the repository and start coding.

• Check if your code passes cargo fmt and cargo clippy.
• Check if your code is self explanatory, if not it should be documented by comments.

• Add a proper testing framework to the code base.
• Add unit tests for package managers.
• Split up code into more maintainable parts, eg. putting every linux package manager in a own submodule of linux.rs.