Extendable version manager with support for Ruby, Node.js, Elixir, Erlang & more
Go to file
Akash Manohar J 4d82f4a992 Update readme
2014-11-30 21:41:58 +05:30
bin Use erlang as an example source 2014-11-29 20:16:29 +05:30
lib Create the sources dir before clone a source dir 2014-11-30 21:39:56 +05:30
.gitignore Add sources dir to gitignore 2014-11-30 21:37:59 +05:30
README.md Update readme 2014-11-30 21:41:58 +05:30

asdf version manager

for everything that needs a version manager

asdf is an extendable version manager.

Add or create a source for any package/language/tool you want. There's a simple API for it.

Manage sources

Sources are how asdf understands how to handle packages.

Add a source for a package

asdf source-add <name> <git-url>

Say you want to add Erlang. There's a package source for it at https://github.com/HashNuke/asdf-erlang.

asdf source-add erlang https://github.com/HashNuke/asdf-erlang.git

Remove a source

asdf source-remove <name>

Now you want to remove the package source for erlang you added earlier.

asdf source-remove erlang

Update sources

To update all sources run the following

asdf source-update --all

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

asdf source-update <name>

Manage packages

# 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 <name>

List all available versions

# asdf list-all <name>
asdf list-all erlang

Use a specific version of a package

asdf use <name> <version>
asdf use erlang 17.3

It writes the version to the .versions file in the current working directory.

The .versions file

Add a .versions file to your project dir and versions of those packages will be used.

elixir 1.0.2
erlang 17.3

Creating package sources

A package source is a git repo, with the following executable scripts

  • bin/list-all - lists all installable versions
  • bin/install - installs the specified version
  • bin/uninstall - uninstalls the specified version
  • bin/use - whatever you want to run when a specific version is used (like set an env var?)

bin/list-all

This script should list stable versions that can be installed

bin/install

This script should install the package. It will be passed the following command-line args (in order).

  • install type - "version", "tag", "commit"
  • version - this is the version or commit sha or the tag name that should be installed (use the first argument to figure out what to do).
  • install path - the dir where the it should be installed

Any other args that comes after this is whatever the user passes to the install command. Feel free to use them in whatever way you think is appropriate.

These scripts are run when list-all, install, uninstall or use commands are run. You can set or unset env vars and do whatever you need.

bin/uninstall

Uninstalls a command

You'll get the same args as the install script.

bin/use

Will be passed the following args

  • install type
  • version

Feel free to set env vars and do what is appropriate to setup the version of the package for use.

Credits

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

Copyright 2014 to the end of time