Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
topgrade(1)		     General Commands Manual		     topgrade(1)

NAME
     topgrade

SYNOPSIS
     topgrade	[--edit-config]   [--config-reference]	[-t|--tmux]  [--no-tmux]
     [-c|--cleanup]  [-n|--dry-run]  [-r|--run-type]  [--no-retry]   [--disable]
     [--only] [--custom-commands] [--env] [-v|--verbose] [-k|--keep] [--skip-no-
     tify]   [-y|--yes]   [--disable-predefined-git-repos]   [--config]   [--re-
     mote-host-limit]	  [--show-skipped]     [--allow-root]	  [--log-filter]
     [--no-self-update] [-h|--help] [-V|--version]

DESCRIPTION
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> [default: wet]
	    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 argument

		   * wet: Executing commands will perform actual execution

		   * damp: Executing commands will print the command and perform
		     actual execution

     --no-retry
	    Do not ask to retry failed steps

     --disable <STEP>...
	    Do not perform upgrades for the given steps

	    [possible  values:	am,  android_studio,  app_man, aqua, asdf, atom,
	    atuin, audit, auto_cpufreq, bin, bob, brew_cask, brew_formula,  bun,
	    bun_packages, cargo, certbot, chezmoi, chocolatey, choosenim, cinna-
	    mon_spices,  clam_av_db, composer, conda, config_update, containers,
	    cursor, custom_commands, deb_get, deno, distrobox, dkp_pacman,  dot-
	    net,  elan,  emacs,  falconf,  firmware,  flatpak,	flutter, fossil,
	    gcloud,    gem,	ghcup,	   git_repos,	  github_cli_extensions,
	    gnome_shell_extensions,  go,  guix,  haxelib, helix, helm, home_man-
	    ager, hyprpm, jetbrains_aqua,  jetbrains_clion,  jetbrains_datagrip,
	    jetbrains_dataspell,   jetbrains_gateway,	jetbrains_goland,   jet-
	    brains_idea, jetbrains_mps,  jetbrains_phpstorm,  jetbrains_pycharm,
	    jetbrains_rider,   jetbrains_rubymine,   jetbrains_rustrover,   jet-
	    brains_toolbox, jetbrains_webstorm, jetpack,  julia,  juliaup,  kak-
	    oune, krew, lensfun, lure, macports, mamba, mandb, mas, maza, micro,
	    microsoft_store, miktex, mise, myrepos, nix, nix_helper, node, opam,
	    pacdef,  pacstall, pearl, pip3, pip_review, pip_review_local, pipup-
	    grade, pipx, pipxu,  pixi,	pkg,  pkgfile,	pkgin,	platformio_core,
	    pnpm,  poetry,  powershell,  protonup,  pyenv,  raco,  rcm, remotes,
	    restarts, rtcl, ruby_gems, rustup, rye, scoop, sdkman,  self_update,
	    sheldon, shell, snap, sparkle, spicetify, stack, stew, system, tldr,
	    tlmgr, tmux, toolbx, typst, uv, vagrant, vcpkg, vim, volta_packages,
	    vscode,   vscode_insiders,	vscodium,  vscodium_insiders,  waydroid,
	    winget, wsl, wsl_update, xcodes, yadm, yarn, yazi, zigup, zvm]

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

	    [possible values: am, android_studio,  app_man,  aqua,  asdf,  atom,
	    atuin,  audit, auto_cpufreq, bin, bob, brew_cask, brew_formula, bun,
	    bun_packages, cargo, certbot, chezmoi, chocolatey, choosenim, cinna-
	    mon_spices, clam_av_db, composer, conda, config_update,  containers,
	    cursor,  custom_commands, deb_get, deno, distrobox, dkp_pacman, dot-
	    net, elan,	emacs,	falconf,  firmware,  flatpak,  flutter,  fossil,
	    gcloud,	gem,	 ghcup,     git_repos,	  github_cli_extensions,
	    gnome_shell_extensions, go, guix, haxelib,	helix,	helm,  home_man-
	    ager,  hyprpm,  jetbrains_aqua, jetbrains_clion, jetbrains_datagrip,
	    jetbrains_dataspell,   jetbrains_gateway,	jetbrains_goland,   jet-
	    brains_idea,  jetbrains_mps,  jetbrains_phpstorm, jetbrains_pycharm,
	    jetbrains_rider,   jetbrains_rubymine,   jetbrains_rustrover,   jet-
	    brains_toolbox,  jetbrains_webstorm,  jetpack,  julia, juliaup, kak-
	    oune, krew, lensfun, lure, macports, mamba, mandb, mas, maza, micro,
	    microsoft_store, miktex, mise, myrepos, nix, nix_helper, node, opam,
	    pacdef, pacstall, pearl, pip3, pip_review, pip_review_local,  pipup-
	    grade,  pipx,  pipxu,  pixi,  pkg,	pkgfile, pkgin, platformio_core,
	    pnpm, poetry,  powershell,	protonup,  pyenv,  raco,  rcm,	remotes,
	    restarts,  rtcl, ruby_gems, rustup, rye, scoop, sdkman, self_update,
	    sheldon, shell, snap, sparkle, spicetify, stack, stew, system, tldr,
	    tlmgr, tmux, toolbx, typst, uv, vagrant, vcpkg, vim, volta_packages,
	    vscode,  vscode_insiders,  vscodium,  vscodium_insiders,   waydroid,
	    winget, wsl, wsl_update, xcodes, yadm, yarn, yazi, 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

     --skip-notify
	    Skip sending a notification at the end of a run

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

	    [possible  values:	am,  android_studio,  app_man, aqua, asdf, atom,
	    atuin, audit, auto_cpufreq, bin, bob, brew_cask, brew_formula,  bun,
	    bun_packages, cargo, certbot, chezmoi, chocolatey, choosenim, cinna-
	    mon_spices,  clam_av_db, composer, conda, config_update, containers,
	    cursor, custom_commands, deb_get, deno, distrobox, dkp_pacman,  dot-
	    net,  elan,  emacs,  falconf,  firmware,  flatpak,	flutter, fossil,
	    gcloud,    gem,	ghcup,	   git_repos,	  github_cli_extensions,
	    gnome_shell_extensions,  go,  guix,  haxelib, helix, helm, home_man-
	    ager, hyprpm, jetbrains_aqua,  jetbrains_clion,  jetbrains_datagrip,
	    jetbrains_dataspell,   jetbrains_gateway,	jetbrains_goland,   jet-
	    brains_idea, jetbrains_mps,  jetbrains_phpstorm,  jetbrains_pycharm,
	    jetbrains_rider,   jetbrains_rubymine,   jetbrains_rustrover,   jet-
	    brains_toolbox, jetbrains_webstorm, jetpack,  julia,  juliaup,  kak-
	    oune, krew, lensfun, lure, macports, mamba, mandb, mas, maza, micro,
	    microsoft_store, miktex, mise, myrepos, nix, nix_helper, node, opam,
	    pacdef,  pacstall, pearl, pip3, pip_review, pip_review_local, pipup-
	    grade, pipx, pipxu,  pixi,	pkg,  pkgfile,	pkgin,	platformio_core,
	    pnpm,  poetry,  powershell,  protonup,  pyenv,  raco,  rcm, remotes,
	    restarts, rtcl, ruby_gems, rustup, rye, scoop, sdkman,  self_update,
	    sheldon, shell, snap, sparkle, spicetify, stack, stew, system, tldr,
	    tlmgr, tmux, toolbx, typst, uv, vagrant, vcpkg, vim, volta_packages,
	    vscode,   vscode_insiders,	vscodium,  vscodium_insiders,  waydroid,
	    winget, wsl, wsl_update, xcodes, yadm, yarn, yazi, 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

     --log-filter <LOG_FILTER> [default: warn]
	    Tracing filter directives.

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

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

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

     -V, --version
	    Print version

VERSION
     v16.9.0

				 topgrade 16.9.0		     topgrade(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=topgrade&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>

home | help