The purpose of the asdf plugins repository is to enable shorthand installation of plugins with:
asdf plugin add <name>The asdf core team recommend using the long-form which does not rely on this repository:
asdf plugin add <name> <git_url>Read each plugins code before installation and usage.
Plugins listed here should be stable and actively maintained. If you have issues with a specific plugin please raise them on the plugin repository first. If a deprecated plugin is listed here, please let us know and create a PR to add the most used alternative.
- Read the creating plugins guide
- Consider using our Template which has the core functionality to tools published to GitHub releases and CI for GitHub/GitLab/CircleCI out of the box.
If you're creating a new plugin consider creating it as part of the asdf-community project. This is a separate community project with consolidated maintenance.
- Install repo dependencies:
asdf install - Add the plugin to the repository
README.mdPlugin List table. - Create a file with the shortname you wish to be used by asdf in
plugins/<name>. The contents should berepository = <your_repo>.- eg:
printf "repository = https://github.com/asdf-vm/asdf-nodejs.git\n" > plugins/nodejs
- eg:
- Test your code :
scripts/test_plugin.bash --file plugins/<name> - Format your code & this README:
scripts/format.bash - Create a PR following the instructions in the PR template.
The asdf core provides a security policy which covers the core asdf tool. Plugins are the responsibility of their creators and not covered by the asdf policy. It is the responsibility of the user to evaluate each plugin they use for security concerns, even those in the asdf-community repositories. You can pin a plugin to a commit of the source repo with asdf plugin update <name> <git-ref>, however running asdf plugin update <name> or asdf plugin update --all will change the sha you have previously set.