Installation

Installation Methods

From Cargo

Needs a Rust toolchain:

cargo install urx

From Homebrew

brew install urx

# or from the project tap
brew install hahwul/urx/urx

From the AUR

Arch Linux, with an AUR helper:

yay -S urx
# or
paru -S urx

From Chocolatey

Windows, with Chocolatey:

choco install urx

This installs the windows-x86_64 release binary and adds urx to PATH.

From GitHub Releases

Each release has prebuilt binaries, each with a .sha256 checksum:

Unpack it and put urx on your $PATH.

From Source

git clone https://github.com/hahwul/urx.git
cd urx
cargo build --release

The binary is at target/release/urx.

Optional: Redis Cache Support

The Redis cache backend (--cache-type redis) is an optional Cargo feature. No packaged build (crates.io, Homebrew, AUR, Chocolatey, release binaries, Docker) includes it. Build it yourself:

cargo install urx --features redis-cache
# or, from a source checkout
cargo build --release --features redis-cache

From Docker

docker pull ghcr.io/hahwul/urx:latest

The image has no entrypoint, so put ./urx before the arguments:

docker run --rm ghcr.io/hahwul/urx:latest ./urx example.com

# piping domains in needs -i
cat domains.txt | docker run --rm -i ghcr.io/hahwul/urx:latest ./urx

Tags: latest, the release version (e.g. 0.11.0), and main for the development branch.

Verifying Installation

urx --version

Shell Completions and Man Page

Both are generated by the binary, so they match the installed version:

# zsh (any directory on your $fpath)
urx --completions zsh > ~/.zfunc/_urx

# bash
urx --completions bash > ~/.local/share/bash-completion/completions/urx

# fish
urx --completions fish > ~/.config/fish/completions/urx.fish

# man page
urx --manpage > ~/.local/share/man/man1/urx.1
man urx

powershell and elvish also work. See CLI Options.

Next Steps

See the Quick Start.