topgrade(1) General Commands Manual topgrade(1) # [NAME](#NAME) topgrade # [SYNOPSIS](#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**] # [DESCRIPTION](#DESCRIPTION) # [OPTIONS](#OPTIONS) [**--edit-config**](#edit) Edit the configuration file [**--config-reference**](#config) Show config reference [**-t**, **--tmux**](#t) Run inside tmux [**--no-tmux**](#no) Don't run inside tmux [**-c**, **--cleanup**](#c) Cleanup temporary or old files [**-n**, **--dry-run**](#n) Print what would be done Alias for --run-type dry [**-r**, **--run-type** *<RUN\_TYPE>* \[default: wet\]](#r) 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 [**--no-ask-retry**](#no~2) Do not ask what to do after a step fails [**--auto-retry** *<COUNT>*](#auto) Automatically retry failed steps up to COUNT times [**--disable** *<STEP>...*](#disable) 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 - 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 - 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 - 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>...*](#only) 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 - 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 - 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 - 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>...*](#custom) Run only specific custom commands [**--env** *<NAME=VALUE>...*](#env) Set environment variables [**-v**, **--verbose**](#v) Output debug logs. Alias for \`--log-filter debug\` [**-k**, **--keep**](#k) Prompt for a key before exiting [**--notify-end** *<NOTIFY\_END>* \[default: always\]](#notify) 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 [**-y**, **--yes** \[*<STEP>...*\]](#y) 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 - 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 - 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 - 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**](#disable~2) Don't pull the predefined git repos [**--config** *<PATH>*](#config~2) Alternative configuration file [**--remote-host-limit** *<REGEX>*](#remote) A regular expression for restricting remote host execution [**--show-skipped**](#show) Show the reason for skipped steps [**--allow-root**](#allow) Suppress warning and confirmation prompt if running as root [**--sudoloop**](#sudoloop) Periodically run \`sudo -v\` to avoid password re-prompts during updates [**--sudoloop-interval** *<SECONDS>*](#sudoloop~2) Interval in seconds between \`sudo -v\` invocations when --sudoloop is active (default: 240) [**--log-filter** *<LOG\_FILTER>* \[default: warn\]](#log) Tracing filter directives. See: https://docs.rs/tracing-subscriber/latest/tracing\_subscriber/filter/struct.EnvFilter.html#directives [**--no-self-update**](#no~3) Don't update Topgrade [**-h**, **--help**](#h) Print help (see a summary with '-h') [**-V**, **--version**](#V) Print version # [VERSION](#VERSION) v17.14.0 topgrade 17.14.0 --- Document: topgrade(8) from topgrade 17.14.0-r0 (Chainguard OS) Source: https://github.com/topgrade-rs/topgrade