2021-05-26 05:55:54 -07:00
# asdf [![Lint](https://github.com/asdf-vm/asdf/actions/workflows/lint.yml/badge.svg)](https://github.com/asdf-vm/asdf/actions/workflows/lint.yml) [![Tests](https://github.com/asdf-vm/asdf/actions/workflows/tests.yml/badge.svg)](https://github.com/asdf-vm/asdf/actions/workflows/tests.yml)
2018-01-13 19:07:07 -07:00
2022-06-01 12:12:32 -07:00
**Manage multiple runtime versions with a single CLI tool, extendable via plugins** - [docs at asdf-vm.com ](https://asdf-vm.com/ )
2014-09-29 09:51:09 -07:00
2020-09-18 22:40:11 -07:00
asdf is a CLI tool that can manage multiple language runtime versions on a per-project basis. It is like `gvm` , `nvm` , `rbenv` & `pyenv` (and more) all in one! Simply install your language's plugin!
2018-11-09 16:43:17 -07:00
2020-09-18 22:40:11 -07:00
## Why use asdf?
2014-11-30 06:46:11 -07:00
2019-01-29 04:31:34 -07:00
- single CLI for multiple languages
- consistent commands to manage all your languages
- single global config keeping defaults in one place
- single `.tool-versions` config file per project
- support for existing config files `.node-version` , `.nvmrc` , `.ruby-version` for easy migration
2019-02-11 10:00:14 -07:00
- automatically switches runtime versions as you traverse your directories
2019-01-29 04:31:34 -07:00
- simple plugin system to add support for your language of choice
2021-11-18 03:05:27 -07:00
- shell completion available for common shells (Bash, Zsh, Fish, Elvish)
2019-01-04 09:40:14 -07:00
2019-01-29 04:31:34 -07:00
## Documentation
2019-01-04 09:40:14 -07:00
2022-06-01 12:12:32 -07:00
[Please head over to the documentation site for more information ](https://asdf-vm.com/ )!
2014-11-30 06:46:11 -07:00
2022-06-01 12:12:32 -07:00
- [Getting Started ](https://asdf-vm.com/guide/getting-started.html )
- [All Commands ](https://asdf-vm.com/manage/commands.html )
2021-07-22 22:26:21 -07:00
- [All Plugins ](https://github.com/asdf-vm/asdf-plugins )
2022-06-01 12:12:32 -07:00
- [Create a Plugin ](https://asdf-vm.com/plugins/create.html ) with our [asdf-plugin-template ](https://github.com/asdf-vm/asdf-plugin-template )
2019-11-30 17:40:43 -07:00
- [asdf GitHub Actions ](https://github.com/asdf-vm/actions )
2017-07-26 09:05:30 -07:00
2017-08-08 11:18:51 -07:00
## Contributing
2022-06-01 12:12:32 -07:00
See [CONTRIBUTING.md in the repo ](https://github.com/asdf-vm/asdf/blob/master/CONTRIBUTING.md ) or the [Contributing section on the docs site ](http://asdf-vm.com/contribute/core.html#initial-setup ).
2020-12-15 04:04:35 -07:00
2020-08-10 16:03:13 -07:00
## Community & Questions
2022-06-01 12:12:32 -07:00
- [FAQ ](https://asdf-vm.com/learn-more/faq.html )
2021-01-12 14:41:33 -07:00
- [![GitHub Issues ](https://icongr.am/simple/github.svg?color=808080&size=16 ) GitHub Issues](https://github.com/asdf-vm/asdf/issues): report a bug or raise a feature request to the `asdf` core team
2020-09-18 22:40:11 -07:00
- [![StackOverflow Tag ](https://icongr.am/fontawesome/stack-overflow.svg?size=16&color=808080 ) StackOverflow Tag](https://stackoverflow.com/questions/tagged/asdf-vm): see existing Q& A for `asdf` . Some of the core team watch this tag in addition to our helpful community
2021-07-22 22:26:21 -07:00
## Ballad of asdf
> Once upon a time there was a programming language<br/>
> There were many versions of it<br/>
> So people wrote a version manager for it<br/>
> To switch between versions for projects<br/>
> Different, old, new.
2022-11-09 08:12:40 -07:00
>
2021-07-22 22:26:21 -07:00
> Then there came more programming languages<br/>
> So there came more version managers<br/>
> And many commands for them
2022-11-09 08:12:40 -07:00
>
2021-07-22 22:26:21 -07:00
> I installed a lot of them<br/>
> I learnt a lot of commands
2022-11-09 08:12:40 -07:00
>
2021-07-22 22:26:21 -07:00
> Then I said, just one more version manager<br/>
> Which I will write instead
2022-11-09 08:12:40 -07:00
>
2021-07-22 22:26:21 -07:00
> So, there came another version manager<br/>
> **asdf version manager** - <https://github.com/asdf-vm/asdf>
2022-11-09 08:12:40 -07:00
>
2021-07-22 22:26:21 -07:00
> A version manager so extendable<br/>
> for which anyone can create a plugin<br/>
> To support their favourite language<br/>
> No more installing more version managers<br/>
> Or learning more commands
---
< figure >
< blockquote >
This was the mail I wrote to a few friends to tell them about the project. Thanks to < a href = "https://twitter.com/roshanvid" target = "_blank" rel = "noreferrer" > @roshanvid< / a > for suggesting that this go into the readme
< / blockquote >
< figcaption >
< a href = "https://github.com/HashNuke" target = "_blank" rel = "noreferrer" > @HashNuke< / a >
< / figcaption >
< / figure >