Extendable version manager with support for Ruby, Node.js, Elixir, Erlang & more
Go to file
Akash Manohar 6abf98af4d Merge pull request #44 from tuvistavie/fish-support
Add fish support. Thank you @tuvistavie and @RobLoach for trying out fish shell support ~!
2016-04-24 22:19:06 +05:30
bin Don't spawn subshells, use exec 2015-10-01 19:31:53 +02:00
completions Add fish support. 2016-04-18 16:33:14 +09:00
docs Documentation about custom shim 2015-06-07 00:37:57 +05:30
lib Add support for config file. 2016-04-24 22:39:24 +09:00
test Add support for config file. 2016-04-24 22:39:24 +09:00
.gitignore Add .vagrant to gitignore 2015-05-19 11:00:59 +05:30
.travis.yml Add support for config file. 2016-04-24 22:39:24 +09:00
asdf.fish Add fish support. 2016-04-18 16:33:14 +09:00
asdf.sh Adds (very) basic zsh autocompletion 2015-12-05 11:14:37 +01:00
ballad-of-asdf.md Review and update 2015-05-22 10:11:10 +05:30
defaults Add support for config file. 2016-04-24 22:39:24 +09:00
help.txt Add more details to the 'asdf install' command help. 2015-11-17 07:35:17 -05:00
LICENSE Add license file. Thanks to @mosic for reporting 2016-03-16 10:27:58 +05:30
README.md Add fish support. 2016-04-18 16:33:14 +09:00
Vagrantfile Add a Vagrantfile to test on ubuntu 2015-05-19 11:00:40 +05:30

asdf

extendable version manager

Supported languages include Ruby, Node.js, Elixir and more. Supporting a new language is as simple as this plugin API.

SETUP

Copy-paste the following into command line:

git clone https://github.com/asdf-vm/asdf.git ~/.asdf

Depending on your OS, run the following

# For Ubuntu or other linux distros
echo '. $HOME/.asdf/asdf.sh' >> ~/.bashrc
echo '. $HOME/.asdf/completions/asdf.bash' >> ~/.bashrc

# OR for Max OSX
echo '. $HOME/.asdf/asdf.sh' >> ~/.bash_profile
echo '. $HOME/.asdf/completions/asdf.bash' >> ~/.bash_profile

If you use zsh or any other shell, replace .bashrc with the config file for the respective shell.

For fish, you can use the following:

echo 'source ~/.asdf/asdf.fish' >> ~/.config/fish/config.fish
mkdir -p ~/.config/fish/completions; and cp ~/.asdf/completions/asdf.fish ~/.config/fish/completions

For most plugins, it is good if you have installed the following packages OR their equivalent on you OS

  • OS X: Install these via homebrew automake autoconf openssl libyaml readline libxslt libtool unixodbc
  • Ubuntu: automake autoconf libreadline-dev libncurses-dev libssl-dev libyaml-dev libxslt-dev libffi-dev libtool unixodbc-dev

That's all ~! You are ready to use asdf


USAGE

Manage plugins

Plugins are how asdf understands how to handle different packages. Below is a list of plugins for languages. There is a super-simple API for supporting more languages.

Language Repository
Elixir asdf-vm/asdf-elixir
Erlang asdf-vm/asdf-erlang
Go kennyp/asdf-golang
Lua Stratus3D/asdf-lua
OpenResty smashedtoatoms/asdf-openresty
Node.js asdf-vm/asdf-nodejs
Postgres smashedtoatoms/asdf-postgres
Redis smashedtoatoms/asdf-redis
Riak smashedtoatoms/asdf-riak
Ruby asdf-vm/asdf-ruby
Add a plugin
asdf plugin-add <name> <git-url>
# asdf plugin-add erlang https://github.com/asdf-vm/asdf-erlang.git
List installed plugins
asdf plugin-list
# asdf plugin-list
Remove a plugin
asdf plugin-remove <name>
# asdf plugin-remove erlang
Update plugins
asdf plugin-update --all

If you want to update a specific package, just say so.

asdf plugin-update <name>
# asdf plugin-update erlang

Manage versions

asdf install <name> <version>
# asdf install erlang 17.3

asdf which <name>
# asdf which erlang
# 17.3

asdf uninstall <name> <version>
# asdf uninstall erlang 17.3

If a plugin supports downloading & compiling from source, you can also do this ref:foo (replace foo with the branch/tag/commit). You'll have to use the same name when uninstalling too.

Lists installed versions
asdf list <name>
# asdf list erlang
List all available versions
asdf list-all <name>
# asdf list-all erlang

The .tool-versions file

Add a .tool-versions file to your project dir and versions of those tools will be used. Global defaults can be set in the file $HOME/.tool-versions

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:v1.0.2-a or 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.

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 .tool-versions file.

Credits

Me (@HashNuke), High-fever, cold, cough.

Copyright 2014 to the end of time (MIT License)


Read the ballad.