Installation

Instructions for installing Garnet on various operating systems and platforms.

macOS (Darwin)

Install garnet binary with curl on macOS

1) Download the latest release

curl -LO https://garnet.jfrog.io/artifactory/garnet-release/garnet-v0.1.0-darwin-amd64

Note: For Apple M1 (arm64) architectures, download the binary: garnet-v0.1.0-darwin-arm64

2) Make the binary executable, and move it to a file location on your system PATH.

chmod +x ./garnet-v0.1.0-darwin-amd64
sudo mv ./garnet-v0.1.0-darwin-amd64 /usr/local/bin/garnet
sudo chown root: /usr/local/bin/garnet

3) Test to ensure the version you installed is up-to-date:

garnet version

Install with Homebrew on macOS

coming soon

Linux (Debian/Ubuntu, Alpine, CentOS/RedHat)

Install garnet binary with curl on Linux

1) Download the latest release

curl -LO https://garnet.jfrog.io/artifactory/garnet-release/garnet-v0.1.0-linux-amd64

2) Install garnet

sudo install -o root -g root -m 0755 garnet-v0.1.0-linux-amd64 /usr/local/bin/garnet

Note: If you do not have root access on the target system, you can still install garnet to the ~/.local/bin directory:

mkdir -p ~/.local/bin/garnet
chmod +x ./garnet-v0.1.0-linux-amd64
mv ./garnet-v0.1.0-linux-amd64 ~/.local/bin/garnet/garnet
​
# and then add ~/.local/bin/garnet to $PATH
​
alias garnet="~/.local/bin/garnet/garnet"

3) Test to ensure the version you installed is up-to-date:

garnet version

Windows

Install garnet binary with curl on Windows

1) If you have curl installed, use this command

curl -LO https://garnet.jfrog.io/artifactory/garnet-release/garnet-v0.1.0-windows-amd64.exe

If you don't have curl installed on Windows, download it using instructions here

2) Add the binary to your system PATH

setx PATH "C:\garnet-v0.1.0-windows-amd64.exe;%PATH%"
ren β€œC:\garnet-v0.1.0-windows-amd64.exe” β€œgarnet.exe”

3) Test to ensure the version you installed is up-to-date:

garnet version

Install the garnet binary directly

1) Download the latest release

2) Add the binary to your system PATH

If you downloaded the file directly, the typical location would be C:\Users\<your-user>\Downloads\garnet-v0.1.0-windows-amd64.exe. Adjust your path accordingly.

setx PATH "C:\garnet-v0.1.0-windows-amd64.exe;%PATH%"

3) Test to ensure the version you installed is up-to-date:

garnet version

Go environment

Requires Go v1.16 or greater

If you have a functional Go environment, you can install the CLI module using

$ go get github.com/garnet-labs/cli

​