VersionFox

[English] [中文文档]

Introduction

VersionFox is a cross-platform tool for managing SDK versions. It allows you to quickly install and switch between different versions of SDKs using the command line. SDKs are provided as plugins in the form of Lua scripts. This means you can implement your own SDK sources or use plugins shared by others to install SDKs. It all depends on your imagination. ;)

Why use VersionFox?

• cross-platform support (Windows, Linux, macOS)
• single CLI for multiple languages
• consistent commands to manage all your languages
• support Global、Project、Session scopes when switching versions
• simple plugin system to add support for your language of choice
• automatically switches runtime versions as you traverse your project
• shell completion available for common shells (Bash, Zsh, Powershell)
• it's faster than asdf-vm, and offers more simple commands and genuine cross-platform unification. see What-is-the-difference-with-asdf?

Demo

Quickstart

Install VersionFox (For detailed installation see Installation)

$ brew tap version-fox/tap
$ brew install vfox

Hook VersionFox into your shell (pick one that works for your shell)

echo 'eval "$(vfox activate bash)"' >> ~/.bashrc
echo 'eval "$(vfox activate zsh)"' >> ~/.zshrc
echo 'vfox activate fish | source' >> ~/.config/fish/config.fish

# For PowerShell, add the following line to your $PROFILE:
Invoke-Expression "$(vfox activate pwsh)"

Add an SDK plugin (For detailed usage see Getting Started)

$ vfox add zig/zig

Install an SDK version

$ vfox install zig@0.11.0

Use the installed SDK version

$ vfox use zig@0.11.0
$ zig version
0.11.0

Documentation

• Getting Started
• Commands Overview
• Plugins Repository
• How to write a custom plugin?
• What is the difference with asdf-vm?

For more information, read the Wiki.

Contributors

Thanks to following people who contributed to this project. 🎉🎉🙏🙏

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the project
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a pull request

Plugin Contributions, please go to version-fox-plugins.

License

Distributed under the Apache 2.0 License. See LICENSE for more information.