Install | vx latest docs

Quick Install

For macOS and Linux, install the latest release with:

curl -fsSL https://raw.githubusercontent.com/vandordev/vx/main/scripts/install.sh | sh

Install a pinned release:

VERSION=v0.1.0 curl -fsSL https://raw.githubusercontent.com/vandordev/vx/main/scripts/install.sh | sh

Override the install directory:

BIN_DIR=/usr/local/bin curl -fsSL https://raw.githubusercontent.com/vandordev/vx/main/scripts/install.sh | sh

The installer defaults to $HOME/.local/bin and prints a PATH hint if that directory is not currently exported by your shell.

gh repo clone vandordev/vx
cd vx
just build
just install

vx is built from the executable package in cmd/vx, so the install path must target that package instead of the module root.

go install github.com/vandordev/vx/cmd/vx@latest

If you already cloned the repository locally:

go install ./cmd/vx

Do not use go install github.com/vandordev/vx@latest; the module root is not an executable main package.

Windows users should use:

go install github.com/vandordev/vx/cmd/vx@latest

When release artifacts are published, download the archive for your platform from:

https://github.com/vandordev/vx/releases

Example for Linux AMD64:

curl -L https://github.com/vandordev/vx/releases/latest/download/vx-linux-amd64.tar.gz | tar -xz
sudo mv vx-linux-amd64 /usr/local/bin/vx

Once the tap is published:

brew tap vandordev/homebrew-vx
brew install vx

Once the package is published:

yay -S vx

vx --version