kevin/asdf

mirror of https://github.com/asdf-vm/asdf.git synced 2024-11-15 01:28:17 -07:00

Extendable version manager with support for Ruby, Node.js, Elixir, Erlang & more

asdf-vm cli elixir erlang multiple-languages nodejs ruby shell version-manager

Go to file

Akash Manohar b85f434419 Review and update Just reviewed this. Note to self: Don't point out other projects. It's their hardwork. Sorry. I can erase the git history, but that's like doing something bad and saying "I didn't do it" So, I'll just leave the history/commits out in the open. Thanks for your understanding		2015-05-22 10:11:10 +05:30
bin	Use source and set env vars for exec-env	2015-05-21 14:35:26 +05:30
docs	Rename docs/ballad-of-asdf.md to ballad-of-asdf.md	2015-05-22 06:59:27 +05:30
lib	Update plugin-push and plugin-update	2015-05-21 10:01:09 +05:30
.gitignore	Add .vagrant to gitignore	2015-05-19 11:00:59 +05:30
asdf.sh	Fix #1 : Better to stick to a single common shell	2015-05-19 10:44:10 +05:30
ballad-of-asdf.md	Review and update	2015-05-22 10:11:10 +05:30
help.txt	Take up less vertical space for help command	2015-05-18 08:01:04 +05:30
README.md	Update README.md	2015-05-22 10:04:41 +05:30
Vagrantfile	Add a Vagrantfile to test on ubuntu	2015-05-19 11:00:40 +05:30

README.md

asdf

extendable version manager

I've built plugins to support the following languages:

Ruby

Erlang

Elixir

There is a super-simple API for supporting more languages.

SETUP

Copy-paste the following into command line:

git clone https://github.com/HashNuke/asdf.git ~/.asdf

Depending on your OS, run the following

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

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

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

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 ncurses 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.

Add a plugin

asdf plugin-add <name> <git-url>
# asdf plugin-add erlang https://github.com/HashNuke/asdf-erlang.git

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 uninstall <name> <version>
# asdf uninstall erlang 17.3

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 how 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.

Credits

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

Read the ballad.