topgrade(1)

πŸ“¦
version 17.4.0 Β· 3 versions
, in alpine 3.24

πŸŽ€ topgrade β€” General Commands Manual πŸŽ€

hi bestie!! okay so this is the topgrade page from the General Commands Manual, and it's genuinely the single most iconic command on your whole machine πŸ’… no cap, it's the one that goes around upgrading everything for you.


✨ NAME ✨

topgrade β€” literally the name says it all πŸ’–


πŸ¦‹ SYNOPSIS πŸ¦‹

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]

like, look at all those flags. it's giving main character energy πŸ‘‘


🌸 DESCRIPTION 🌸

okay so, huge mood: this section is empty in the original page. nothing here. it's a vibe-only blank space 🫢 so we're not inventing anything, we're just moving on to the good part.


πŸ’… OPTIONS πŸ’…

the group chat of flags, in order, no skips:

  • --edit-config β€” open up the config file so you can edit it ✏️
  • --config-reference β€” show the config reference, iykyk
  • -t, --tmux β€” run it inside tmux
  • --no-tmux β€” don't run it inside tmux
  • -c, --cleanup β€” clean up temporary or old files 🧹
  • -n, --dry-run β€” just print what would be done, nothing gets touched 🫧

alias for --run-type dry, bestie

  • -r, --run-type <RUN_TYPE> [default: wet] β€” pick between just running commands, running and logging commands, or just logging commands. your three icons:
    • dry β€” executing commands will just print the command with its argument
    • wet β€” executing commands will perform actual execution
    • damp β€” executing commands will print the command and perform actual execution
  • --no-ask-retry β€” don't ask what to do after a step fails πŸ™ˆ
  • --auto-retry <COUNT> β€” automatically retry failed steps up to COUNT times πŸ”
  • --disable <STEP>... β€” do not perform upgrades for the given steps πŸ™…β€β™€οΈ

possible values, and yes there are a lot, we're listing them all because I would never do you like that:

  • am
  • android_studio
  • antigravity
  • app_man
  • 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
  • colima
  • composer
  • conda
  • config_update
  • containers
  • cursor
  • 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
  • home_manager
  • hyprpm
  • 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
  • pacdef
  • pacstall
  • pearl
  • pi
  • pip3
  • pip_review
  • pip_review_local
  • pipupgrade
  • pipx
  • pipxu
  • pixi
  • pkg
  • pkgfile
  • pkgin
  • platformio_core
  • pnpm
  • poetry
  • powershell
  • protonplus
  • protonup
  • pyenv
  • raco
  • rcm
  • remotes
  • restarts
  • rtcl
  • ruby_gems
  • rustup
  • rye
  • scoop
  • sdkman
  • self_update
  • sheldon
  • shell
  • skills
  • snap
  • 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
  • zigup
  • zvm
  • --only <STEP>... β€” perform only the specified steps πŸ‘€ same energy, opposite direction:

possible values:

  • am
  • android_studio
  • antigravity
  • app_man
  • 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
  • colima
  • composer
  • conda
  • config_update
  • containers
  • cursor
  • 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
  • home_manager
  • hyprpm
  • 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
  • pacdef
  • pacstall
  • pearl
  • pi
  • pip3
  • pip_review
  • pip_review_local
  • pipupgrade
  • pipx
  • pipxu
  • pixi
  • pkg
  • pkgfile
  • pkgin
  • platformio_core
  • pnpm
  • poetry
  • powershell
  • protonplus
  • protonup
  • pyenv
  • raco
  • rcm
  • remotes

(the list keeps going in the next chunk of the page, we're not done yet πŸ’œ)

  • restarts
  • rtcl
  • ruby_gems
  • rustup
  • rye
  • scoop
  • sdkman
  • self_update
  • sheldon
  • shell
  • skills
  • snap
  • 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
  • zigup
  • zvm

ok that's the whole alphabet soup, no cap πŸ’€ every single step name, straight from the source.

  • --custom-commands <NAME>... β€” only run the custom commands you name, nothing else. selective queen behavior πŸ’…
  • --env <NAME=VALUE>... β€” set environment variables for the run. yes bestie, you can pass more than one.
  • -v, --verbose β€” output debug logs. it's literally just an alias for --log-filter debug, so don't act surprised when it's loud.
  • -k, --keep β€” prompt for a key before exiting. perfect if you want to screenshot the chaos before the window vanishes 🫢
  • --notify-end <NOTIFY_END> [default: always] β€” decides when the end-of-run notification goes out ✨

possible values:

  • always β€” always send a notification (this is the default, icon behavior)
  • never β€” never send a notification
  • on_failure β€” only send a notification if there were failures 😭
  • -y, --yes [<STEP>...] β€” say yes to the package manager's prompt. you can scope it to specific steps, or just let it ride. the possible values are:
    • am
    • android_studio
    • antigravity
    • app_man
    • 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
    • colima
    • composer
    • conda
    • config_update
    • containers
    • cursor
    • 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
    • home_manager
    • hyprpm
    • 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
    • pacdef
    • pacstall
    • pearl
    • pi
    • pip3
    • pip_review
    • pip_review_local
    • pipupgrade
    • pipx
    • pipxu
    • pixi
    • pkg
    • pkgfile
    • pkgin
    • platformio_core
    • pnpm
    • poetry
    • powershell
    • protonplus
    • protonup
    • pyenv
    • raco
    • rcm
    • remotes
    • restarts
    • rtcl
    • ruby_gems
    • rustup
    • rye
    • scoop
    • sdkman
    • self_update
    • sheldon
    • shell
    • skills
    • snap
    • 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
    • zigup
    • zvm
  • --disable-predefined-git-repos β€” don't pull the predefined git repos. if you don't want that default repo pull, this is your girl πŸŽ€
  • --config <PATH> β€” use an alternative configuration file. point it wherever your heart wants.
  • --remote-host-limit <REGEX> β€” a regular expression that restricts remote host execution. yes, a regex, so be careful and be precise 🧚
  • --show-skipped β€” show the reason why steps got skipped. finally, the lore πŸ™ˆ
  • --allow-root β€” suppresses the warning and the confirmation prompt if you're running as root. highkey powerful, use it on purpose.
  • --sudoloop β€” periodically runs sudo -v so you don't get password re-prompts in the middle of updates. the way this saves you 😭
  • --sudoloop-interval <SECONDS> β€” how many seconds between sudo -v invocations when --sudoloop is active (default: 240).
  • --log-filter <LOG_FILTER> [default: warn] β€” tracing filter directives.

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

  • --no-self-update β€” don't update Topgrade. sometimes you're just not in the mood to grow ✨
  • -h, --help β€” print help (see a summary with -h).
  • -V, --version β€” print version.

πŸ¦‹ VERSION πŸ¦‹

v17.4.0

and that's the whole page, bestie β€” you ate that πŸ’… this absolute icon of a manual is topgrade 17.4.0, documented under the topgrade(1) page. go forth, update everything, and remember: reading the manpage is main character energy πŸ‘‘πŸ«Ά

πŸ“¦ where this page comes from