OS Manuals

topgrade(8)

topgrade

topgrade(1) General Commands Manual topgrade(1)

topgrade

topgrade [--edit-config] [--config-reference] [-t|--tmux] [--no-tmux] [-c|--cleanup] [-n|--dry-run] [-r|--run-type] [--no-ask-retry] [--auto-retry] [--disable] [--only] [--custom-commands] [--env] [-v|--verbose] [-k|--keep] [--notify-end] [-y|--yes] [--disable-predefined-git-repos] [--config] [--remote-host-limit] [--show-skipped] [--allow-root] [--sudoloop] [--sudoloop-interval] [--log-filter] [--no-self-update] [-h|--help] [-V|--version]

Edit the configuration file
Show config reference
Run inside tmux
Don't run inside tmux
Cleanup temporary or old files
Print what would be done

Alias for --run-type dry

Pick between just running commands, running and logging commands, and just logging commands

Possible values:

  • dry: Executing commands will just print the command with its arguments
  • wet: Executing commands will perform actual execution
  • damp: Executing commands will print the command and perform actual execution
Do not ask what to do after a step fails
Automatically retry failed steps up to COUNT times
Do not perform upgrades for the given steps

Possible values:

  • am
  • adless
  • android_studio
  • antigravity
  • antigravity_cli
  • app_man
  • app_manager
  • aqua
  • asdf
  • atom
  • atuin
  • audit
  • auto_cpufreq
  • bin
  • bob
  • brew_cask
  • brew_formula
  • bun
  • bun_packages
  • cargo
  • certbot
  • chezmoi
  • chocolatey
  • choosenim
  • cinnamon_spices
  • clam_av_db
  • claude_code
  • claude_code_plugins
  • codex
  • colima
  • composer
  • conda
  • config_update
  • containers
  • cursor
  • cursor_agent
  • custom_commands
  • deb_get
  • deno
  • distrobox
  • dkp_pacman
  • dotnet
  • elan
  • emacs
  • falconf
  • firmware
  • flatpak
  • flutter
  • fossil
  • gcloud
  • gearlever
  • gem
  • getnf
  • ghcup
  • git_repos
  • github_cli_extensions
  • gnome_shell_extensions
  • go
  • guix
  • haxelib
  • helix
  • helix_db
  • helm
  • hermes_agent
  • home_manager
  • hyprpm
  • install_release
  • jetbrains_aqua
  • jetbrains_clion
  • jetbrains_datagrip
  • jetbrains_dataspell
  • jetbrains_gateway
  • jetbrains_goland
  • jetbrains_idea
  • jetbrains_mps
  • jetbrains_phpstorm
  • jetbrains_pycharm
  • jetbrains_rider
  • jetbrains_rubymine
  • jetbrains_rustrover
  • jetbrains_toolbox
  • jetbrains_webstorm
  • jetpack
  • julia
  • juliaup
  • kakoune
  • krew
  • lensfun
  • lure
  • macports
  • mamba
  • mandb
  • mas
  • maza
  • micro
  • microsoft_office
  • microsoft_store
  • miktex
  • mise
  • myrepos
  • nix
  • nix_helper
  • node
  • ollama
  • opam
  • opencode
  • pacdef
  • pacstall
  • pearl
  • pi
  • pip3
  • pip_review
  • pip_review_local
  • pipupgrade
  • pipx
  • pipxu
  • pixi
  • pkg
  • pkgfile
  • pkgin
  • pkgit
  • platformio_core
  • pnpm
  • poetry
  • powershell
  • protonplus
  • protonup
  • pyenv
  • raco
  • rcm
  • remotes
  • restarts
  • rtcl
  • ruby_gems
  • rustup
  • rye
  • scoop
  • sdkman
  • self_update
  • sera
  • sheldon
  • shell
  • skills
  • snap
  • soar
  • sparkle
  • spicetify
  • stack
  • stew
  • system
  • tldr
  • tlmgr
  • tmux
  • toolbx
  • tpack
  • typst
  • uv
  • vagrant
  • vcpkg
  • vim
  • vite_plus
  • volta_packages
  • vscode
  • vscode_insiders
  • vscodium
  • vscodium_insiders
  • waydroid
  • windsurf
  • winget
  • wsl
  • wsl_update
  • xcodes
  • yadm
  • yarn
  • yazi
  • zed
  • zerobrew
  • zigup
  • zvm
Perform only the specified steps

Possible values:

  • am
  • adless
  • android_studio
  • antigravity
  • antigravity_cli
  • app_man
  • app_manager
  • aqua
  • asdf
  • atom
  • atuin
  • audit
  • auto_cpufreq
  • bin
  • bob
  • brew_cask
  • brew_formula
  • bun
  • bun_packages
  • cargo
  • certbot
  • chezmoi
  • chocolatey
  • choosenim
  • cinnamon_spices
  • clam_av_db
  • claude_code
  • claude_code_plugins
  • codex
  • colima
  • composer
  • conda
  • config_update
  • containers
  • cursor
  • cursor_agent
  • custom_commands
  • deb_get
  • deno
  • distrobox
  • dkp_pacman
  • dotnet
  • elan
  • emacs
  • falconf
  • firmware
  • flatpak
  • flutter
  • fossil
  • gcloud
  • gearlever
  • gem
  • getnf
  • ghcup
  • git_repos
  • github_cli_extensions
  • gnome_shell_extensions
  • go
  • guix
  • haxelib
  • helix
  • helix_db
  • helm
  • hermes_agent
  • home_manager
  • hyprpm
  • install_release
  • jetbrains_aqua
  • jetbrains_clion
  • jetbrains_datagrip
  • jetbrains_dataspell
  • jetbrains_gateway
  • jetbrains_goland
  • jetbrains_idea
  • jetbrains_mps
  • jetbrains_phpstorm
  • jetbrains_pycharm
  • jetbrains_rider
  • jetbrains_rubymine
  • jetbrains_rustrover
  • jetbrains_toolbox
  • jetbrains_webstorm
  • jetpack
  • julia
  • juliaup
  • kakoune
  • krew
  • lensfun
  • lure
  • macports
  • mamba
  • mandb
  • mas
  • maza
  • micro
  • microsoft_office
  • microsoft_store
  • miktex
  • mise
  • myrepos
  • nix
  • nix_helper
  • node
  • ollama
  • opam
  • opencode
  • pacdef
  • pacstall
  • pearl
  • pi
  • pip3
  • pip_review
  • pip_review_local
  • pipupgrade
  • pipx
  • pipxu
  • pixi
  • pkg
  • pkgfile
  • pkgin
  • pkgit
  • platformio_core
  • pnpm
  • poetry
  • powershell
  • protonplus
  • protonup
  • pyenv
  • raco
  • rcm
  • remotes
  • restarts
  • rtcl
  • ruby_gems
  • rustup
  • rye
  • scoop
  • sdkman
  • self_update
  • sera
  • sheldon
  • shell
  • skills
  • snap
  • soar
  • sparkle
  • spicetify
  • stack
  • stew
  • system
  • tldr
  • tlmgr
  • tmux
  • toolbx
  • tpack
  • typst
  • uv
  • vagrant
  • vcpkg
  • vim
  • vite_plus
  • volta_packages
  • vscode
  • vscode_insiders
  • vscodium
  • vscodium_insiders
  • waydroid
  • windsurf
  • winget
  • wsl
  • wsl_update
  • xcodes
  • yadm
  • yarn
  • yazi
  • zed
  • zerobrew
  • zigup
  • zvm
Run only specific custom commands
Set environment variables
Output debug logs. Alias for `--log-filter debug`
Prompt for a key before exiting
When to send a notification at the end of a run

Possible values:

  • always: Always send a notification (default)
  • never: Never send a notification
  • on_failure: Only send a notification if there were failures
Say yes to package manager's prompt

Possible values:

  • am
  • adless
  • android_studio
  • antigravity
  • antigravity_cli
  • app_man
  • app_manager
  • aqua
  • asdf
  • atom
  • atuin
  • audit
  • auto_cpufreq
  • bin
  • bob
  • brew_cask
  • brew_formula
  • bun
  • bun_packages
  • cargo
  • certbot
  • chezmoi
  • chocolatey
  • choosenim
  • cinnamon_spices
  • clam_av_db
  • claude_code
  • claude_code_plugins
  • codex
  • colima
  • composer
  • conda
  • config_update
  • containers
  • cursor
  • cursor_agent
  • custom_commands
  • deb_get
  • deno
  • distrobox
  • dkp_pacman
  • dotnet
  • elan
  • emacs
  • falconf
  • firmware
  • flatpak
  • flutter
  • fossil
  • gcloud
  • gearlever
  • gem
  • getnf
  • ghcup
  • git_repos
  • github_cli_extensions
  • gnome_shell_extensions
  • go
  • guix
  • haxelib
  • helix
  • helix_db
  • helm
  • hermes_agent
  • home_manager
  • hyprpm
  • install_release
  • jetbrains_aqua
  • jetbrains_clion
  • jetbrains_datagrip
  • jetbrains_dataspell
  • jetbrains_gateway
  • jetbrains_goland
  • jetbrains_idea
  • jetbrains_mps
  • jetbrains_phpstorm
  • jetbrains_pycharm
  • jetbrains_rider
  • jetbrains_rubymine
  • jetbrains_rustrover
  • jetbrains_toolbox
  • jetbrains_webstorm
  • jetpack
  • julia
  • juliaup
  • kakoune
  • krew
  • lensfun
  • lure
  • macports
  • mamba
  • mandb
  • mas
  • maza
  • micro
  • microsoft_office
  • microsoft_store
  • miktex
  • mise
  • myrepos
  • nix
  • nix_helper
  • node
  • ollama
  • opam
  • opencode
  • pacdef
  • pacstall
  • pearl
  • pi
  • pip3
  • pip_review
  • pip_review_local
  • pipupgrade
  • pipx
  • pipxu
  • pixi
  • pkg
  • pkgfile
  • pkgin
  • pkgit
  • platformio_core
  • pnpm
  • poetry
  • powershell
  • protonplus
  • protonup
  • pyenv
  • raco
  • rcm
  • remotes
  • restarts
  • rtcl
  • ruby_gems
  • rustup
  • rye
  • scoop
  • sdkman
  • self_update
  • sera
  • sheldon
  • shell
  • skills
  • snap
  • soar
  • sparkle
  • spicetify
  • stack
  • stew
  • system
  • tldr
  • tlmgr
  • tmux
  • toolbx
  • tpack
  • typst
  • uv
  • vagrant
  • vcpkg
  • vim
  • vite_plus
  • volta_packages
  • vscode
  • vscode_insiders
  • vscodium
  • vscodium_insiders
  • waydroid
  • windsurf
  • winget
  • wsl
  • wsl_update
  • xcodes
  • yadm
  • yarn
  • yazi
  • zed
  • zerobrew
  • zigup
  • zvm
Don't pull the predefined git repos
Alternative configuration file
A regular expression for restricting remote host execution
Show the reason for skipped steps
Suppress warning and confirmation prompt if running as root
Periodically run `sudo -v` to avoid password re-prompts during updates
Interval in seconds between `sudo -v` invocations when --sudoloop is active (default: 240)
Tracing filter directives.

See: https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives

Don't update Topgrade
Print help (see a summary with '-h')
Print version

v17.12.3

topgrade 17.12.3

topgrade 17.12.3-r2 · os · ingested 2026-10-16