Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/weskoerber/zvm
Zig Version Manager - POSIX-compliant shell script to manage multiple active Zig versions.
https://github.com/weskoerber/zvm
version-manager zig ziglang
Last synced: 3 months ago
JSON representation
Zig Version Manager - POSIX-compliant shell script to manage multiple active Zig versions.
- Host: GitHub
- URL: https://github.com/weskoerber/zvm
- Owner: weskoerber
- License: mit
- Created: 2024-02-07T20:24:24.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-05-20T01:15:51.000Z (6 months ago)
- Last Synced: 2024-05-20T07:25:44.038Z (6 months ago)
- Topics: version-manager, zig, ziglang
- Language: Shell
- Homepage: https://github.com/weskoerber/zvm
- Size: 56.6 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# zvm - Zig Version Manager
A script to manage your [Zig](https://Ziglang.org) versions.
## Features
- Single POSIX-compliant shell script
- Shell completions (bash, zsh)
- Few dependencies (you probably have them installed already)
## Getting Started
First, make sure `ZVM_BIN` is on your `PATH`. By default, it's `~/.local/bin`:[^1]
- On Linux, `/home//.local/bin`
- On Windows, `C:\Users\\.local\bin`
- On MacOS, `/Users//.local/bin`
Next, determine if you need to explicitly set your target. On Linux you
probably won't have to, put if you're on Windows or MacOS, see the
[Cross-platform support](#cross-platform-support) section below.
### Prerequisites
- A POSIX-compliant shell
- [curl](https://curl.se/download.html)
- [jq](https://jqlang.github.io/jq/)
- tar
- unzip
### Usage
Without any commands, `zvm` will print the currently active Zig version and
exit. Specific actions may be performed my providing a command.
## Commands
### `list`
Alias: `ls`
List Zig versions from the remote index:
```shell
zvm list
```
List installed Zig versions:
```shell
zvm list -i
zvm list --installed
```
### `install`
Alias: `i`
Install a Zig version:
```shell
zvm install 0.12.0
```
Install a Zig version and make it active immediately:
```shell
zvm install -u 0.12.0
zvm install --use 0.12.0
```
### `use`
Use an installed Zig version:
```shell
zvm use 0.12.0
```
### `uninstall`
Alias: `rm`
Uninstall a Zig version:
```shell
zvm uninstall 0.11.0
```
By default, the `uninstall` command will prevent the current version from being
uninstalled. To bypass, there are 2 options:
1. Fall back to the newest installed version with `-l,--use-latest`
2. Force removal
- Note that after forcing removal, the `zig` command will no longer exist
and you'll have to use the `use` command to select a new version
### `help`
Alias: `h`
Show `zvm` help:
```shell
zvm help
```
## Customizing
### Environment
- `ZVM_HOME` - `zvm` home directory (where `zvm` downloads and extracts Zig tarballs)
- `ZVM_BIN` - `zvm` bin directory (where `zvm` links Zig binaries)
## TODO
- [ ] Support building from source?
- [x] Allow custom download location (default: `$HOME/.local/share/zvm`)
- 9b1afd4
- [x] Allow custom install prefix (default: `$HOME/.local/bin/zig`)
- 9b1afd4
## Cross-platform support
### Linux
Native support. `zvm`'s detected native target will likely work, but you can
override it if you need to.
### Windows
Supported via various Linux subsystems (git-bash, WSL, etc.).
`zvm` uses `uname` to detect the target and it currently only uses what `uname`
provides, which will differ depending on the Linux subsystem used (git-bash,
WSL, mingw, etc). However, [Zig's
targets](https://ziglang.org/documentation/master/std/#std.Target.Os.Tag) use
`windows` as the OS name. Due to this, for now you'll have to explicitly set
your target:
```shell
zvm --target -windows
```
Replace `` with one of the following:
- On a 32-bit system, `x86` (e.g. `x86-windows`)
- On a 64-bit x86 system, `x86-64` (e.g. `x86_64-windows`)
- On a 64-bit aarch64 system, aarch64 (e.g. `aarch64-windows`)
### MacOS
Supported natively but shares the same gotchas as the Windows support.
`zvm` uses `uname` to detect the target and it currently only uses what `uname`
provides. However, [Zig's
targets](https://ziglang.org/documentation/master/std/#std.Target.Os.Tag) use
`macos` as the OS name instead of `darwin`, which is what `uname` will return.
Due to this, for now you'll have to explicitly set your target:
```shell
zvm --target -macos
```
Replace `` with one of the following:
- On a 64-bit x86 system, `x86-64` (e.g. `x86_64-macos`)
- On a 64-bit aarch64 system (a.k.a 'Apple silicon'), `aarch64` (e.g.
`aarch64-macos`)
---
[^1]: You can override this path with the `ZVM_BIN` environment variable. See
the [Environment](#environment) section for details.