diff options
Diffstat (limited to 'plugins/asdf/README.md')
| -rw-r--r-- | plugins/asdf/README.md | 54 |
1 files changed, 36 insertions, 18 deletions
diff --git a/plugins/asdf/README.md b/plugins/asdf/README.md index f047860e2..69db6930a 100644 --- a/plugins/asdf/README.md +++ b/plugins/asdf/README.md @@ -1,30 +1,48 @@ -## asdf - -**Maintainer:** [@RobLoach](https://github.com/RobLoach) +# asdf Adds integration with [asdf](https://github.com/asdf-vm/asdf), the extendable version manager, with support for Ruby, Node.js, Elixir, Erlang and more. -### Installation +## Installation -1. [Download asdf](https://asdf-vm.com/guide/getting-started.html#_2-download-asdf) by running the following: +1. [Install](https://asdf-vm.com/guide/getting-started.html#_1-install-asdf) asdf and ensure that's it's discoverable on `$PATH`; +2. Enable it by adding it to your `plugins` definition in `~/.zshrc`: - ``` - git clone https://github.com/asdf-vm/asdf.git ~/.asdf - ``` +```sh +plugins=(asdf) +``` -2. [Enable asdf](https://asdf-vm.com/guide/getting-started.html#_3-install-asdf) by adding it to your `plugins` definition in `~/.zshrc`. +## Usage - ``` - plugins=(asdf) - ``` +Refer to the [asdf plugin documentation](https://asdf-vm.com/guide/getting-started.html#_4-install-a-plugin) for information on how to add a plugin and install the many runtime versions for it. -### Usage +Example for installing the nodejs plugin and the many runtimes for it: -See the [asdf documentation](https://asdf-vm.com/guide/getting-started.html#_4-install-a-plugin) for information on how to use asdf: +```sh +# Add plugin to asdf +asdf plugin add nodejs -``` -asdf plugin add nodejs https://github.com/asdf-vm/asdf-nodejs.git +# Install the latest available version asdf install nodejs latest -asdf global nodejs latest -asdf local nodejs latest + +# Uninstall the latest version +asdf uninstall nodejs latest + +# Install a specific version +asdf install nodejs 16.5.0 + +# Set the latest version in .tool-versions of the `current directory` +asdf set nodejs latest + +# Set a specific version in the `parent directory` +asdf set -p nodejs 16.5.0 # -p is shorthand for --parent + +# Set a global version under `$HOME` +asdf set -u nodejs 16.5.0 # -u is shorthand for --home ``` + +For more commands, run `asdf help` or refer to the +[asdf CLI documentation](https://asdf-vm.com/manage/commands.html#all-commands). + +## Maintainer + +- [@RobLoach](https://github.com/RobLoach) |