Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

Installation

Quick Install

Auto-detects OS and architecture, then installs to:

  • /usr/local/bin when run as root
  • ~/.local/bin when run as a regular user
curl -fsSL https://raw.githubusercontent.com/dzmbs/hlz/main/install.sh | sh

Install Options

# Explicit install directory
curl -fsSL https://raw.githubusercontent.com/dzmbs/hlz/main/install.sh | sh -s -- --bin-dir "$HOME/.local/bin"
 
# System-wide install
curl -fsSL https://raw.githubusercontent.com/dzmbs/hlz/main/install.sh | sh -s -- --system

Manual Download

Download from GitHub Releases:

macOS (Apple Silicon)
curl -fsSL -o hlz https://github.com/dzmbs/hlz/releases/latest/download/hlz-darwin-arm64
chmod +x hlz && mv hlz "$HOME/.local/bin/"

If ~/.local/bin is not in your PATH, add export PATH="$HOME/.local/bin:$PATH" to your shell profile.

Static binaries — Linux builds are statically linked (musl). Zero dependencies, runs on any distro. ~827KB.

Build from Source

Requires Zig 0.15.2.

git clone https://github.com/dzmbs/hlz
cd hlz
 
# Production build (827KB stripped binary)
zig build -Doptimize=ReleaseSmall
 
# Fastest execution (1.2MB)
zig build -Doptimize=ReleaseFast
 
# Debug build (fast compile)
zig build

Binaries are output to zig-out/bin/.

As a Zig Dependency

Add to your build.zig.zon:

.dependencies = .{
    .hlz = .{
        .url = "git+https://github.com/dzmbs/hlz#main",
    },
},

Then in build.zig:

const hlz_dep = b.dependency("hlz", .{
    .target = target,
    .optimize = optimize,
});
exe.root_module.addImport("hlz", hlz_dep.module("hlz"));

Verify

hlz version
hlz price BTC

Updating

curl -fsSL https://raw.githubusercontent.com/dzmbs/hlz/main/install.sh | sh

Or from source:

git pull && zig build -Doptimize=ReleaseSmall