OS Manuals

/usr/bin/topgrade

Detects which tools you use and runs the appropriate commands to update them

From topgrade 17.16.0-r0 (os), captured 2026-11-10 by running topgrade --help (exit 0). permalink

Usage: topgrade [OPTIONS]

Options:
      --edit-config
          Edit the configuration file

      --config-reference
          Show config reference

  -t, --tmux
          Run inside tmux

      --no-tmux
          Don't run inside tmux

  -c, --cleanup
          Cleanup temporary or old files

  -n, --dry-run
          Print what would be done

          Alias for --run-type dry

  -r, --run-type <RUN_TYPE>
          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

          [default: wet]

      --no-ask-retry
          Do not 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: am, adless, android_studio, antigravity, antigravity_cli, antigravity_ide, 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, github_cli_skills, 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, lucid_link, 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, pre_commit_gc, 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, tailscale, 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]

      --only <STEP>...
          Perform only the specified steps

          [possible values: am, adless, android_studio, antigravity, antigravity_cli, antigravity_ide, 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, github_cli_skills, 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, lucid_link, 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, pre_commit_gc, 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, tailscale, 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]

      --custom-commands <NAME>...
          Run only specific custom commands

      --env <NAME=VALUE>...
          Set environment variables

  -v, --verbose
          Output debug logs. Alias for `--log-filter debug`

  -k, --keep
          Prompt for a key before exiting

      --notify-end <NOTIFY_END>
          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

          [default: always]

  -y, --yes [<STEP>...]
          Say yes to package manager's prompt

          [possible values: am, adless, android_studio, antigravity, antigravity_cli, antigravity_ide, 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, github_cli_skills, 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, lucid_link, 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, pre_commit_gc, 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, tailscale, 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]

      --disable-predefined-git-repos
          Don't pull the predefined git repos

      --config <PATH>
          Alternative configuration file

      --remote-host-limit <REGEX>
          A regular expression for restricting remote host execution

      --show-skipped
          Show the reason for skipped steps

      --allow-root
          Suppress warning and confirmation prompt if running as root

      --sudoloop
          Periodically run `sudo -v` to avoid password re-prompts during updates

      --sudoloop-interval <SECONDS>
          Interval in seconds between `sudo -v` invocations when --sudoloop is active (default: 240)

      --log-filter <LOG_FILTER>
          Tracing filter directives.

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

          [default: warn]

      --no-self-update
          Don't update Topgrade

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version
Options (28)
OptionDescriptionSource
--edit-configEdit the configuration filehelp + man
--config-referenceShow config referencehelp + man
-t, --tmuxRun inside tmuxhelp + man
--no-tmuxDon't run inside tmuxhelp + man
-c, --cleanupCleanup temporary or old fileshelp + man
-n, --dry-runPrint what would be donehelp + man
-r, --run-type RUN_TYPEPick between just running commands, running and logging commands, and just logging commandshelp
--no-ask-retryDo not ask what to do after a step failshelp + man
--auto-retry COUNTAutomatically retry failed steps up to COUNT timeshelp + man
--disable STEP>...Do not perform upgrades for the given stepshelp + man
--only STEP>...Perform only the specified stepshelp + man
--custom-commands NAME>...Run only specific custom commandshelp + man
--env NAME=VALUE>...Set environment variableshelp + man
-v, --verboseOutput debug logs.help + man
-k, --keepPrompt for a key before exitinghelp + man
--notify-end NOTIFY_ENDWhen to send a notification at the end of a runhelp
-y, --yes STEP>...Say yes to package manager's prompthelp
--disable-predefined-git-reposDon't pull the predefined git reposhelp + man
--config PATHAlternative configuration filehelp + man
--remote-host-limit REGEXA regular expression for restricting remote host executionhelp + man
--show-skippedShow the reason for skipped stepshelp + man
--allow-rootSuppress warning and confirmation prompt if running as roothelp + man
--sudoloopPeriodically run `sudo -v` to avoid password re-prompts during updateshelp + man
--sudoloop-interval SECONDSInterval in seconds between `sudo -v` invocations when --sudoloop is active (default: 240)help + man
--log-filter LOG_FILTERTracing filter directives.help
--no-self-updateDon't update Topgradehelp + man
-h, --helpPrint help (see a summary with '-h')help + man
-V, --versionPrint versionhelp + man

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.