Installation

Installation

Requirements: Go 1.24+ (for go install / source builds). The binary itself has no runtime dependencies.

Go install (recommended)

go install github.com/v0id00/propq/cmd/propq@latest

The binary lands in $(go env GOPATH)/bin/propq. Make sure ~/go/bin is on your PATH:

export PATH="$HOME/go/bin:$PATH"

Verify:

propq --version

Download binary

Grab the latest release for your platform from the releases page.

# Linux amd64
curl -L https://github.com/v0id00/propq/releases/latest/download/propq-linux-amd64 -o propq
chmod +x propq
./propq --version

# Linux 32-bit (x86)
curl -L https://github.com/v0id00/propq/releases/latest/download/propq-linux-x86 -o propq
chmod +x propq

# macOS (Intel)
curl -L https://github.com/v0id00/propq/releases/latest/download/propq-macos-amd64 -o propq
chmod +x propq

# macOS (Apple Silicon)
curl -L https://github.com/v0id00/propq/releases/latest/download/propq-macos-arm64 -o propq
chmod +x propq

# Windows 64-bit
curl -L https://github.com/v0id00/propq/releases/latest/download/propq-windows-amd64.exe -o propq.exe

# Windows 32-bit
curl -L https://github.com/v0id00/propq/releases/latest/download/propq-windows-x86.exe -o propq.exe

Build from source

git clone https://github.com/v0id00/propq.git
cd propq
make build
# binary is in build/propq

Other useful targets: make install (to $GOPATH/bin), make build-all (cross-compile all 7 platforms).

Shell completion

propq completion bash | sudo tee /etc/bash_completion.d/propq
propq completion zsh | sudo tee /usr/local/share/zsh/site-functions/_propq
propq completion fish > ~/.config/fish/completions/propq.fish
propq completion powershell > propq.ps1

Then restart your shell or reload completion.

First run

# Generate a starter config, then edit it
propq config generate -o propq.toml

# Or copy the example from the repo
cp propq.toml.example propq.toml

# Test your setup
propq config check
propq servers

Next: Getting-Started