Copy-paste the following into command line:
git clone https://github.com/asdf-vm/asdf.git ~/.asdf --branch v0.5.1
Depending on your OS and shell, run the following:
echo -e '\n. $HOME/.asdf/asdf.sh' >> ~/.bashrc
echo -e '\n. $HOME/.asdf/completions/asdf.bash' >> ~/.bashrc
echo -e '\n. $HOME/.asdf/asdf.sh' >> ~/.bash_profile
echo -e '\n. $HOME/.asdf/completions/asdf.bash' >> ~/.bash_profile
If you are using a framework, such as oh-my-zsh, use these lines. (Be sure that if you make future changes to .zshrc these lines remain below the line where you source your framework.)
echo -e '\n. $HOME/.asdf/asdf.sh' >> ~/.zshrc
echo -e '\n. $HOME/.asdf/completions/asdf.bash' >> ~/.zshrc
If you are not using a framework, or if on starting your shell you get an error message like 'command not found: compinit', then add this line before the ones above.
autoload -Uz compinit && compinit
echo 'source ~/.asdf/asdf.fish' >> ~/.config/fish/config.fish
mkdir -p ~/.config/fish/completions; and cp ~/.asdf/completions/asdf.fish ~/.config/fish/completions
Restart your shell so that PATH changes take effect. (Opening a new terminal tab will usually do it.)
For most plugins, it is good if you have installed the following packages OR their equivalent on your OS
- macOS: Install these via homebrew
coreutils automake autoconf openssl libyaml readline libxslt libtool unixodbc
automake autoconf libreadline-dev libncurses-dev libssl-dev libyaml-dev libxslt-dev libffi-dev libtool unixodbc-dev
automake autoconf readline-devel ncurses-devel openssl-devel libyaml-devel libxslt-devel libffi-devel libtool unixODBC-devel
That's all ~! You are ready to use asdf
Plugins are how asdf understands how to handle different packages.
You can find a list of all asdf plugins in the plugins repository.
There is a super-simple API for supporting more languages.
asdf plugin-add <name> # asdf plugin-add erlang
If the plugin you want to install is not part of the plugins repository, you can add it using its repository URL:
asdf plugin-add <name> <git-url> # asdf plugin-add elm https://github.com/vic/asdf-elm
asdf plugin-list # asdf plugin-list # java # nodejs
asdf plugin-list --urls # asdf plugin-list # java https://github.com/skotchpine/asdf-java.git # nodejs https://github.com/asdf-vm/asdf-nodejs.git
asdf plugin-remove <name> # asdf plugin-remove erlang
asdf plugin-update --all
If you want to update a specific package, just say so.
asdf plugin-update <name> # asdf plugin-update erlang
asdf install <name> <version> # asdf install erlang 17.3 asdf current # asdf current # erlang 17.3 (set by /Users/kim/.tool-versions) # nodejs 6.11.5 (set by /Users/kim/cool-node-project/.tool-versions) asdf current <name> # asdf current erlang # 17.3 (set by /Users/kim/.tool-versions) asdf uninstall <name> <version> # asdf uninstall erlang 17.3
If a plugin supports downloading & compiling from source, you can also do this
foo with the branch/tag/commit). You'll have to use the same name when uninstalling too.
asdf list <name> # asdf list erlang
asdf list-all <name> # asdf list-all erlang
asdf current <name> # asdf current erlang # 17.3 (set by /Users/kim/.tool-versions)
asdf global <name> <version> asdf local <name> <version> # asdf global elixir 1.2.4
global writes the version to
local writes the version to
$PWD/.tool-versions, creating it if needed.
Alternatively, if you want to set a version only for the current shell session
or for executing just a command under a particular tool version, you
can set an environment variable like
The following example runs tests on an Elixir project with version
The version format is the same supported by the
ASDF_ELIXIR_VERSION=1.4.0 mix test
.tool-versions file to your project dir and versions of those tools will be used.
Global defaults can be set in the file
This is what a
.tool-versions file looks like:
ruby 2.2.0 nodejs 0.12.3
The versions can be in the following format:
0.12.3- an actual version. Plugins that support downloading binaries, will download binaries.
ref:39cb398vb39- tag/commit/branch to download from github and compile
path:/src/elixir- a path to custom compiled version of a tool to use. For use by language developers and such.
system- this keyword causes asdf to passthrough to the version of the tool on the system that is not managed by asdf.
To install all the tools defined in a
.tool-versions file run the
asdf install command with no other arguments in the directory containing the
You can view/modify the file by hand or use
asdf local and
asdf global to manage it.
.asdfrc file to your home directory and asdf will use the settings specified in the file. The file should be formatted like this:
legacy_version_file = yes
legacy_version_file- defaults to
no. If set to yes it will cause plugins that support this feature to read the version files used by other version managers (e.g.
.ruby-versionin the case of Ruby's rbenv).
ASDF_CONFIG_FILE- Defaults to
~/.asdfrcas described above. Can be set to any location.
ASDF_DEFAULT_TOOL_VERSIONS_FILENAME- The name of the file storing the tool names and versions. Defaults to
.tool-versions. Can be any valid file name.
The asdf-alpine and asdf-ubuntu projects are an ongoing effort to provide Dockerized images of some asdf tools. You can use these docker images as base for your development servers, or for running your production apps.
To develop the project, you can simply
git clone the master branch.
If you want to try out your changes without making change to your installed
you can set the
$ASDF_DIR variable to the path where you cloned the repository,
and temporarily prepend the
shims directory of the directory to your path.
We use bats for testing,
so make sure
bats test/ passes after you made your changes.
See CONTRIBUTING.md for the contribution guidelines.
Me (@HashNuke), High-fever, cold, cough.
Copyright 2014 to the end of time (MIT License)
Read the ballad.