mirror of
https://github.com/asdf-vm/asdf.git
synced 2024-11-15 01:28:17 -07:00
docs: synchronize help text (#742)
This commit is contained in:
James Hegedus
GitHub
parent
f5c7dae331
commit
605be10046
@ -1,43 +1,8 @@
|
||||
## Manage Plugins
|
||||
<!--
|
||||
single source of truth.
|
||||
import commands list from master branch of repo.
|
||||
not amenable to docs supporting git refs. Solution to be determined.
|
||||
-->
|
||||
`asdf` or `asdf help` will list all available commands for your current asdf version.
|
||||
|
||||
| Command | Effect |
|
||||
| -----------------------------------------| ------------------------------------------------------------ |
|
||||
| `asdf plugin add <name> [<git-url>]` | 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` | List installed 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 remove <name>` | Remove plugin and package versions |
|
||||
| `asdf plugin update <name> [<git-ref>]` | Update plugin to latest commit or a particular git ref. |
|
||||
| `asdf plugin update --all` | Update all plugins |
|
||||
|
||||
## Manage Packages
|
||||
|
||||
| Command | Effect |
|
||||
| ---------------------------------------- | -------------------------------------------------------------------------- |
|
||||
| `asdf install [<name> <version>]` | Install a specific version of a package, or with no arguments, |
|
||||
| | ...install all the package versions listed in the .tool-versions file |
|
||||
| `asdf install <name> latest[:<version>]` | 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 <name> <version>` | Remove a specific version of a package |
|
||||
| `asdf current` | Display current version set or being used for all packages |
|
||||
| `asdf current <name>` | Display current version set or being used for package |
|
||||
| `asdf where <name> [<version>]` | Display install path for an installed or current version |
|
||||
| `asdf which <name>` | Display install path for current version |
|
||||
| `asdf shell <name> <version>` | Set the package version to `ASDF_${LANG}_VERSION` in the current shell |
|
||||
| `asdf local <name> <version>` | Set the package local version |
|
||||
| `asdf global <name> <version>` | Set the package global version |
|
||||
| `asdf latest <name> [<version>]` | Show latest stable version of a package |
|
||||
| `asdf list <name>` | List installed versions of a package |
|
||||
| `asdf list all <name> [<version>]` | List all versions of a package and optionally filter the returned versions |
|
||||
|
||||
## Utils
|
||||
|
||||
| Command | Effect |
|
||||
| ------------------------------ | ----------------------------------------------------- |
|
||||
| `asdf exec <command> [args]` | Runs the currently selected version of command |
|
||||
| `asdf env <command> [util]` | Executes util inside the environment used for command |
|
||||
| `asdf reshim <name> <version>` | Recreate shims for version of a package |
|
||||
| `asdf shim-versions <command>` | 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 |
|
||||
[](https://raw.githubusercontent.com/asdf-vm/asdf/master/help.txt ':include')
|
||||
|
||||
69
help.txt
69
help.txt
@ -1,33 +1,50 @@
|
||||
MANAGE PLUGINS
|
||||
asdf plugin add <name> [<git-url>] 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 <name> Remove plugin and package versions
|
||||
asdf plugin update <name> [<git-ref>] Update a plugin to latest commit or a particular git-ref.
|
||||
asdf plugin update --all Update all plugins
|
||||
asdf plugin add <name> [<git-url>] 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 <name> Remove plugin and package versions
|
||||
asdf plugin update <name> [<git-ref>] Update a plugin to latest commit or a
|
||||
particular git-ref
|
||||
asdf plugin update --all Update all plugins
|
||||
|
||||
|
||||
MANAGE PACKAGES
|
||||
asdf install [<name> <version>] Install a specific version of a package or,
|
||||
with no arguments, install all the package
|
||||
versions listed in the .tool-versions file
|
||||
asdf uninstall <name> <version> Remove a specific version of a package
|
||||
asdf current Display current version set or being used for all packages
|
||||
asdf current <name> Display current version set or being used for package
|
||||
asdf where <name> [<version>] Display install path for an installed or current version
|
||||
asdf which <command> Display the path to an executable
|
||||
asdf shell <name> <version> Set the package version in the current shell
|
||||
asdf local <name> <version> Set the package local version
|
||||
asdf global <name> <version> Set the package global version
|
||||
asdf list <name> List installed versions of a package
|
||||
asdf list all <name> List all versions of a package
|
||||
asdf install [<name> <version>] Install a specific version of a package
|
||||
or, with no arguments, install all the
|
||||
package versions listed in the
|
||||
.tool-versions file
|
||||
asdf install <name> latest[:<version>] 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 <name> <version> Remove a specific version of a package
|
||||
asdf current Display current version set or being
|
||||
used for all packages
|
||||
asdf current <name> Display current version set or being
|
||||
used for package
|
||||
asdf where <name> [<version>] Display install path for an installed
|
||||
or current version
|
||||
asdf which <command> Display the path to an executable
|
||||
asdf local <name> <version> Set the package local version
|
||||
asdf global <name> <version> Set the package global version
|
||||
asdf shell <name> <version> Set the package version to
|
||||
`ASDF_${LANG}_VERSION` in the current shell
|
||||
asdf latest <name> [<version>] Show latest stable version of a package
|
||||
asdf list <name> List installed versions of a package
|
||||
asdf list all <name> [<version>] List all versions of a package and
|
||||
optionally filter the returned versions
|
||||
|
||||
|
||||
UTILS
|
||||
asdf exec <command> [args..] Executes the command shim for current version
|
||||
asdf env <command> [util] Runs util (default: `env`) inside the environment used for command shim execution.
|
||||
asdf reshim <name> <version> Recreate shims for version of a package
|
||||
asdf shim-versions <command> List on which plugins and versions is command available
|
||||
asdf update Update asdf to the latest stable release
|
||||
asdf update --head Update asdf to the latest on the master branch
|
||||
asdf exec <command> [args...] Executes the command shim for current version
|
||||
asdf env <command> [util] Runs util (default: `env`) inside the
|
||||
environment used for command shim execution.
|
||||
asdf reshim <name> <version> Recreate shims for version of a package
|
||||
asdf shim-versions <command> 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
|
||||
|
||||
Loading…
Reference in New Issue
Block a user