Skip to content

Install ​

poolwatch is a single program file. You download it from the GitHub release page, or build it yourself with Rust.

Download the release binary (Linux x86-64) ​

The current release, v0.1.0, has one prebuilt archive: poolwatch-v0.1.0-x86_64-linux-musl.tar.gz, for 64-bit Intel and AMD Linux machines. It has a matching .sha256 file for checking the download.

  1. Download the archive and its checksum:

    bash
    curl -LO https://github.com/Dhiva-Labs/poolwatch/releases/download/v0.1.0/poolwatch-v0.1.0-x86_64-linux-musl.tar.gz
    curl -LO https://github.com/Dhiva-Labs/poolwatch/releases/download/v0.1.0/poolwatch-v0.1.0-x86_64-linux-musl.tar.gz.sha256
  2. Check that the download is complete and unchanged:

    bash
    sha256sum -c poolwatch-v0.1.0-x86_64-linux-musl.tar.gz.sha256

    It prints the file name followed by OK. If it prints FAILED, download the archive again.

  3. Unpack it:

    bash
    tar xzf poolwatch-v0.1.0-x86_64-linux-musl.tar.gz
    cd poolwatch-v0.1.0-x86_64-linux-musl

    The folder holds the poolwatch program, poolwatch.example.toml (a sample configuration), README.md and LICENSE.

  4. Check that it runs:

    bash
    ./poolwatch --version

    It prints poolwatch 0.1.0.

The binary is static, so you can also copy it to a server without a desktop, for example with scp, and run it there.

Optional: run it from anywhere ​

bash
sudo install -m 755 poolwatch /usr/local/bin/poolwatch

Then type poolwatch in any folder.

Build from source ​

Build from source to get poolwatch on Linux ARM64, on Windows, or from the newest code.

  1. Install Rust with rustup. The repository pins the Rust version it uses, and rustup downloads it on the first build.

  2. Download the source:

    bash
    git clone https://github.com/Dhiva-Labs/poolwatch
    cd poolwatch
  3. Build and install:

    bash
    cargo install --path crates/poolwatch-tui

    This puts poolwatch in ~/.cargo/bin, which rustup adds to your PATH.

To build the fully static Linux binary instead, install musl-tools, add the target and build:

bash
rustup target add x86_64-unknown-linux-musl
cargo build --release --target x86_64-unknown-linux-musl

The binary is target/x86_64-unknown-linux-musl/release/poolwatch. On ARM64, use the target aarch64-unknown-linux-musl.

On Windows, cargo install --path crates/poolwatch-tui builds poolwatch.exe. Run it in Windows Terminal or another console with VT support.

Good to know

The source code also has packaging for Windows, Linux ARM64, Fedora, openSUSE and Arch Linux, but these downloads are not part of a published release yet. Check the releases page for what is available now.

Next steps ​