Install¶

Install the latest GitHub Release on macOS or Linux:

curl --proto '=https' --tlsv1.2 -LsSf \
  https://github.com/owebeeone/gwz-cli/releases/latest/download/gwz-installer.sh | sh

Install the latest GitHub Release on Windows PowerShell:

powershell -NoProfile -ExecutionPolicy Bypass -Command "iex (irm https://github.com/owebeeone/gwz-cli/releases/latest/download/gwz-installer.ps1)"

Keep -NoProfile to skip PowerShell startup customizations and the parentheses around irm to pass the downloaded script to iex as one argument. If the previous irm ... | iex command reports an empty command or a missing #> terminator, use the command above.

The latest release URL resolves to the newest non-prerelease GitHub Release. For pinned installs, replace latest with a concrete tag:

https://github.com/owebeeone/gwz-cli/releases/download/v0.9.0/gwz-installer.sh
https://github.com/owebeeone/gwz-cli/releases/download/v0.9.0/gwz-installer.ps1

Install From Source¶

From 1.0.12, users with Rust can build and install the released CLI from crates.io:

cargo install gwz

Or install a release tag from the repository:

cargo install --git https://github.com/owebeeone/gwz-cli --tag v1.0.12 --locked

Replace v1.0.12 with the release you want, but always name a tag: the main branch depends on a sibling gwz-core checkout and builds only inside the gwz-dev workspace. --locked builds with the tag's Cargo.lock.

Both compile from source, so they need Rust 1.95 or newer, a C compiler and, on macOS and Linux, the OpenSSL development files (Homebrew openssl@3, or libssl-dev and pkg-config on Debian and Ubuntu).

For local development inside the source workspace, run the package directly:

cargo run -q -p gwz -- --version
cargo run -q -p gwz -- --help

Use the same form for command help:

cargo run -q -p gwz -- help status

Verify A Release Asset¶

Release assets are checksummed and have GitHub artifact attestations. The installer scripts are convenience entry points; users who need stronger supply chain verification should download the binary archive, verify the attestation, compare the SHA-256 checksum, and then install the binary.

Typical verification flow:

Download the release archive, checksum file, and attestation from the GitHub Release.
Compare the archive hash with the published checksum.
Verify the artifact attestation with GitHub tooling for the release asset.
Run gwz --version and gwz --help.

Smoke Test Installers¶

Test the Unix installer without modifying PATH:

tmp="$(mktemp -d)"

curl --proto '=https' --tlsv1.2 -LsSf \
  https://github.com/owebeeone/gwz-cli/releases/latest/download/gwz-installer.sh \
  -o "${tmp}/gwz-installer.sh"

GWZ_UNMANAGED_INSTALL="${tmp}/bin" \
GWZ_NO_MODIFY_PATH=1 \
sh "${tmp}/gwz-installer.sh"

"${tmp}/bin/gwz" --version
"${tmp}/bin/gwz" --help

Test the Windows installer without modifying PATH:

$ErrorActionPreference = "Stop"

$tmp = Join-Path $env:TEMP "gwz-test-$([guid]::NewGuid())"
New-Item -ItemType Directory -Force -Path $tmp | Out-Null

$installer = Join-Path $tmp "gwz-installer.ps1"
Invoke-WebRequest `
  "https://github.com/owebeeone/gwz-cli/releases/latest/download/gwz-installer.ps1" `
  -OutFile $installer

$env:GWZ_UNMANAGED_INSTALL = Join-Path $tmp "bin"
$env:GWZ_NO_MODIFY_PATH = "1"

Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
& $installer

$exe = Join-Path $env:GWZ_UNMANAGED_INSTALL "gwz.exe"
& $exe --version
& $exe --help

Documentation¶

Continue with the hosted Quick Start or browse the full user documentation.