upstream/ohmyzsh
1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2025-04-08 18:43:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: further refine installation and usage docs

Browse Source
This commit is contained in:
Kartik Vashistha 2025-03-24 11:56:57 +00:00
parent f4d8ef41e7
commit 359458e5ef
1 changed files with 24 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
plugins/asdf/README.md
View File

@ -1,39 +1,39 @@
## asdf
# 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#_1-install-asdf):
```sh
# For macos via homebrew
brew install asdf
```
For OS's where asdf isn't directly available to download via the package manager, follow [this](https://asdf-vm.com/guide/getting-started.html#install-asdf) section.
2. [Enable asdf](https://asdf-vm.com/guide/getting-started.html#_3-install-asdf) by adding it to your `plugins` definition in `~/.zshrc`.
```sh
plugins=(asdf)
```
### Usage
See the [asdf plugin documentation](https://asdf-vm.com/guide/getting-started.html#_4-install-a-plugin) for information on how to use asdf:
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`:
```sh
asdf plugin add nodejs https://github.com/asdf-vm/asdf-nodejs.git
plugins=(asdf)
```
## Usage
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.
Example for installing the nodejs plugin and the many runtimes for it:
```sh
# Add plugin to asdf
asdf plugin add nodejs
# Install the latest available nodejs runtime version
asdf install nodejs latest
# Set the latest version
# Install nodejs v16.5.0 runtime version
asdf install nodejs 16.5.0
# Set the latest version in .tools-version in the current working directory
asdf set nodejs latest
# Set globally to a pinned version
# Set a version globally that will apply to all directories under $HOME
asdf set -u nodejs 16.5.0
```
### Maintainer
## Maintainer
- [@RobLoach](https://github.com/RobLoach)