diff --git a/help.txt b/help.txt index 611dd6ed9..d776fc41a 100644 --- a/help.txt +++ b/help.txt @@ -1,65 +1,81 @@ -MANAGE PLUGINS -asdf plugin add [] Add a plugin from the plugin repo OR, - add a Git repo as a plugin by - specifying the name and repo url -asdf plugin list [--urls] [--refs] List installed plugins. Optionally show - git urls and git-ref -asdf plugin list all List plugins registered on asdf-plugins - repository with URLs -asdf plugin remove Remove plugin and package versions -asdf plugin update [] Update a plugin to latest commit on - default branch or a particular git-ref -asdf plugin update --all Update all plugins to latest commit on - default branch +* CONTEXT PACKAGES +--------------------- + asdf current Display current version set or being + used for all packages + asdf current Display current version set or being + used for package + asdf global Set the package global version + asdf global latest[:] Set the package global version to the + latest provided version + asdf local Set the package local version + asdf local latest[:] Set the package local version to the + latest provided version + asdf shell Set the package version to + `ASDF_${LANG}_VERSION` in the current shell + asdf where [] Display install path for an installed + or current version + asdf which Display the path to an executable -MANAGE PACKAGES -asdf current Display current version set or being - used for all packages -asdf current Display current version set or being - used for package -asdf global Set the package global version -asdf global latest[:] Set the package global version to the - latest provided version -asdf help [] Output documentation for plugin and tool -asdf install Install all the package versions listed - in the .tool-versions file -asdf install Install one tool at the version - specified in the .tool-versions file -asdf install Install a specific version of a package -asdf install latest[:] Install the latest stable version of a - package, or with optional version, - install the latest stable version that - begins with the given string -asdf latest [] Show latest stable version of a package -asdf latest --all Show latest stable version of all the - packages and if they are installed -asdf list [version] List installed versions of a package and - optionally filter the versions -asdf list all [] List all versions of a package and - optionally filter the returned versions -asdf local Set the package local version -asdf local latest[:] Set the package local version to the - latest provided version -asdf shell Set the package version to - `ASDF_${LANG}_VERSION` in the current shell -asdf uninstall Remove a specific version of a package -asdf where [] Display install path for an installed - or current version -asdf which Display the path to an executable +* MANAGE PACKAGES +--------------------- + asdf help [] Output documentation for plugin and tool -UTILS -asdf exec [args...] Executes the command shim for current version -asdf env [util] Runs util (default: `env`) inside the - environment used for command shim execution. -asdf info Print OS, Shell and ASDF debug information. -asdf reshim Recreate shims for version of a package -asdf shim-versions List the plugins and versions that - provide a command -asdf update Update asdf to the latest stable release -asdf update --head Update asdf to the latest on the master branch + asdf list [version] List installed versions of a package and + optionally filter the versions + asdf list all [] List all versions of a package and + optionally filter the returned versions -RESOURCES + asdf latest [] Show latest stable version of a package + asdf latest --all Show latest stable version of all the + packages and if they are installed + asdf install Install all the package versions listed + in the .tool-versions file + asdf install Install one tool at the version + specified in the .tool-versions file + asdf install Install a specific version of a package + asdf install latest[:] Install the latest stable version of a + package, or with optional version, + install the latest stable version that + begins with the given string + asdf uninstall Remove a specific version of a package + + +* MANAGE PLUGINS +--------------------- + asdf plugin list [--urls] [--refs] List installed plugins. Optionally show + git urls and git-ref + asdf plugin list all List plugins registered on asdf-plugins + repository with URLs + asdf plugin add [] Add a plugin from the plugin repo OR, + add a Git repo as a plugin by + specifying the name and repo url + asdf plugin remove Remove plugin and package versions + asdf plugin update [] Update a plugin to latest commit on + default branch or a particular git-ref + asdf plugin update --all Update all plugins to latest commit on + default branch + + +* UTILS +--------------------- + asdf exec [args...] Executes the command shim for current version + asdf env [util] Runs util (default: `env`) inside the + environment used for command shim execution. + asdf reshim Recreate shims for version of a package + asdf shim-versions List the plugins and versions that + provide a command + asdf info Print OS, Shell and ASDF debug information. + asdf update Update asdf to the latest stable release + asdf update --head Update asdf to the latest on the master branch + + +* RESOURCES +--------------------- GitHub: https://github.com/asdf-vm/asdf Docs: https://asdf-vm.com + + +* PLUGINS +---------------------