Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/version-fox/vfox
A cross-platform and extendable version manager with support for Java, Node.js, Flutter, .Net & more
https://github.com/version-fox/vfox
asdf bash cli cmd cross-platform development-tools golang linux lua macos nodejs plugin-manager powershell sdk tools version-manager windows zsh
Last synced: 2 days ago
JSON representation
A cross-platform and extendable version manager with support for Java, Node.js, Flutter, .Net & more
- Host: GitHub
- URL: https://github.com/version-fox/vfox
- Owner: version-fox
- License: apache-2.0
- Created: 2023-12-09T08:57:59.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-13T09:18:28.000Z (4 months ago)
- Last Synced: 2024-10-29T17:27:44.281Z (4 months ago)
- Topics: asdf, bash, cli, cmd, cross-platform, development-tools, golang, linux, lua, macos, nodejs, plugin-manager, powershell, sdk, tools, version-manager, windows, zsh
- Language: Go
- Homepage: https://vfox.lhan.me
- Size: 21.5 MB
- Stars: 2,821
- Watchers: 14
- Forks: 102
- Open Issues: 63
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-version-managers - vfox - A cross-platform, extensible version manager. It supports native Windows and Unix-like. (Version Managers / Generic)
- awesome-ops - version-fox/vfox - 2.0|2739|2023-12-09|2024-09-29 | 跨平台的用于管理 SDK 版本的工具,允许你通过命令行快速安装和切换不同版本的 SDK | (Version-Switch-Tools)
README
![]()
# vfox
[![Go Report Card](https://img.shields.io/badge/go%20report-A+-brightgreen.svg?style=for-the-badge)](https://goreportcard.com/report/github.com/version-fox/vfox)
[![GitHub License](https://img.shields.io/github/license/version-fox/vfox?style=for-the-badge)](LICENSE)
[![GitHub Release](https://img.shields.io/github/v/release/version-fox/vfox?display_name=tag&style=for-the-badge)](https://github.com/version-fox/vfox/releases)
[![Discord](https://img.shields.io/discord/1191981003204477019?style=for-the-badge&logo=discord)](https://discord.gg/85c8ptYgb7)[[English]](./README.md) [[中文文档]](./README_CN.md)
If you **switch between development projects which expect different environments**, specifically different runtime versions or ambient libraries,
or **you are tired of all kinds of cumbersome environment configurations**, `vfox` is the ideal choice for you.## Introduction
**`vfox` is a cross-platform version manager(similar to `nvm`, `fvm`, `sdkman`, `asdf-vm`, etc.), extendable via plugins**. It allows you to quickly install
and switch between different environment you need via the command line.## Why use vfox?
- **cross-platform support** (**Windows**, Linux, macOS)
- **consistent commands** to manage all your languages
- supports **different versions for different projects, different shells, and globally**.
- simple **plugin system** to add support for your runtime of choice
- **automatically switches** runtime versions as you traverse your project
- support for existing config files `.node-version`, `.nvmrc`, `.sdkmanrc` for easy migration
- shell completion available for common shells (Bash, ZSH, Powershell, Clink)
- **it's faster than `asdf-vm`, and offers more simple commands and genuine cross-platform unification.**
see [Comparison with asdf](https://vfox.lhan.me/misc/vs-asdf.html)## Demo
[![asciicast](https://asciinema.org/a/650100.svg)](https://asciinema.org/a/650100)
## Quickstart
> For detailed installation instructions, see [Quick Start](https://vfox.lhan.me/guides/quick-start.html)
#### 1. Choose an [installation](https://vfox.lhan.me/guides/quick-start.html#_1-installation) that works for you.
#### 2. ⚠️ **_Hook `vfox` into your shell_ (pick one that works for your shell)** ⚠️
```bash
echo 'eval "$(vfox activate bash)"' >> ~/.bashrc
echo 'eval "$(vfox activate zsh)"' >> ~/.zshrc
echo 'vfox activate fish | source' >> ~/.config/fish/config.fish# For PowerShell:
if (-not (Test-Path -Path $PROFILE)) { New-Item -Type File -Path $PROFILE -Force }; Add-Content -Path $PROFILE -Value 'Invoke-Expression "$(vfox activate pwsh)"'# For Clink:
# 1. Install clink: https://github.com/chrisant996/clink/releases
# Or Install cmder: https://github.com/cmderdev/cmder/releases
# 2. Find script path: clink info | findstr scripts
# 3. copy internal/shell/clink_vfox.lua to script path# For Nushell:
vfox activate nushell $nu.default-config-dir | save --append $nu.config-path
```> Remember to restart your shell to apply the changes.
#### 3. Add an SDK plugin
```bash
$ vfox add nodejs
```#### 4. Install a runtime
```bash
$ vfox install [email protected]
```#### 5. Switch runtime
```bash
$ vfox use [email protected]
$ node -v
21.5.0
```## Full Documentation
See [vfox.lhan.me](https://vfox.lhan.me) for full documentation.
## Roadmap
Our future plans and high priority features and enhancements are:
- [x] Refactoring the plugin mechanism:
- Introducing plugin templates to facilitate multi-file plugin development.
- Establishing a global registry (similar to `NPM Registry` or `Scoop Main Bucket`) to provide a unified entry point for plugin distribution.
- Decomposing the existing plugin repository into individual repositories, one for each plugin.
- [x] Allowing the switching of registry addresses.
- [x] Plugin capabilities: Parsing legacy configuration files, such as `.nvmrc`, `.node-version`, `.sdkmanrc`, etc.
- [ ] Plugin capabilities: Allowing plugins to load installed runtimes and provide information about the runtime.## Available Plugins
> If you have installed `vfox`, you can view all available plugins with the `vfox available` command.
For more details, see the [Available Plugins](https://vfox.lhan.me/plugins/available.html).
## Contributors
> Thanks to following people who contributed to this project. 🎉🎉🙏🙏
## Contributing
Bug reports, contributions and forks are welcome. All bugs or other forms of discussion happen
on [issues](http://github.com/version-fox/vfox/issues).See more at [CONTRIBUTING.md](./CONTRIBUTING.md).
Plugin Contributions, please go to [Public Registry](https://github.com/version-fox/vfox-plugins)
## Star History
![Star History Chart](https://api.star-history.com/svg?repos=version-fox/vfox&type=Date)
## Thanks
> Thanks JetBrains for the free open source license. :)
## COPYRIGHT
[Apache 2.0 license](./LICENSE) - Copyright (C) 2025 Han Li
and [contributors](https://github.com/version-fox/vfox/graphs/contributors)