Help us shape the future of Go! Take the 2026 Go Developer Survey

asdf

package
v1.49.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 27, 2026 License: MIT Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var AsdfCmd = &cobra.Command{
	Use:   "asdf",
	Short: "Manage asdf version manager plugins and installs",
	Long:  `Command suite for managing asdf version manager plugins, checking project requirements, updating root .tool-versions, and pruning outdated tool installs.`,
	RunE: func(cmd *cobra.Command, args []string) error {

		return runPrune(cmd, args)
	},
}

AsdfCmd is the root command for asdf management.

View Source
var CheckCmd = &cobra.Command{
	Use:     "check",
	Aliases: []string{"verify", "doctor"},
	Short:   "Verify that all required tool versions in .tool-versions files are installed",
	Long: `Scans global and project .tool-versions files and verifies that every required tool version is installed on the system.

Use the --install (-i) flag to automatically install any missing tool versions.`,
	RunE: runCheck,
}

CheckCmd represents the subcommand to verify all .tool-versions requirements are installed.

View Source
var CleanupCmd = PruneCmd

CleanupCmd is an alias variable for backward compatibility.

View Source
var PruneCmd = &cobra.Command{
	Use:     "prune",
	Aliases: []string{"cleanup", "clean"},
	Short:   "Prune outdated asdf tool versions not listed in .tool-versions",
	Long: `Reads the root (user level) .tool-versions file and scans project directories for additional .tool-versions files, then removes installed tool versions that are not explicitly defined.

Use the --interactive (-i) flag to present a multi-select prompt for choosing specific versions to uninstall.
Use the --dry-run (-d) flag to preview which versions would be uninstalled.
Use the --no-scan flag to disable searching development directories for project .tool-versions files.`,
	RunE: runPrune,
}

PruneCmd represents the subcommand to prune outdated asdf installs.

View Source
var StatusCmd = &cobra.Command{
	Use:     "status",
	Aliases: []string{"ls", "list-summary"},
	Short:   "Display an overview dashboard of installed asdf plugins, active versions, and disk usage",
	Long:    `Provides a high-level summary dashboard of all managed asdf plugins, installed version counts, active pinned versions, and total disk space used.`,
	RunE:    runStatus,
}

StatusCmd represents the subcommand to display an environment dashboard of asdf tools.

View Source
var UpdateLatestCmd = &cobra.Command{
	Use:     "update-latest",
	Aliases: []string{"update-root", "update-tools", "upgrade"},
	Short:   "Update .tool-versions file to the latest available releases for each tool (defaults to $HOME/.tool-versions)",
	Long: `Reads a .tool-versions file (defaults to the user level global config at $HOME/.tool-versions), queries 'asdf latest' for each plugin, and updates the file with the newest available releases.

Use the --config (-c) flag to specify a custom .tool-versions file path.
Use the --install (-i) flag to automatically install the upgraded tool versions.
Use the --yes (-y) flag to skip prompts and apply all upgrades.`,
	RunE: runUpdateLatest,
}

UpdateLatestCmd represents the subcommand to update .tool-versions to latest available versions.

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL