Skip to content

Installation

mendsec edited this page Jun 23, 2026 · 1 revision

Installation

Requirements

  • Go 1.26 or later (for source builds only)
  • Linux, macOS, or Windows (amd64 or arm64)
  • Root / administrator privileges for ICMP scanning on some systems — ICMP ping requires raw socket access. See Security for details.

Method 1 — Pre-built Binary (Recommended)

Linux / macOS

curl -sSL https://github.com/mendsec/catnet/releases/latest/download/catnet_Linux_x86_64.tar.gz | tar xz
sudo mv catnet /usr/local/bin/
catnet version

Windows

  1. Download catnet_Windows_x86_64.zip from the Releases page.
  2. Extract the archive.
  3. Add the extracted folder to your PATH.
  4. Verify: catnet.exe version

Always verify your download against the checksums.txt file published with each release:

sha256sum -c checksums.txt

Method 2 — go install

go install github.com/mendsec/catnet/cmd/catnet@latest

This installs the HEAD of the default branch. For reproducible builds, pin to a specific tag:

go install github.com/mendsec/catnet/cmd/catnet@v0.2.0

Method 3 — Build from Source

git clone https://github.com/mendsec/catnet.git
cd catnet
go build -o catnet ./cmd/catnet
./catnet version

To inject a specific version string at build time:

go build -ldflags "-X github.com/mendsec/catnet/internal/cli.Version=v0.2.0" -o catnet ./cmd/catnet

Method 4 — Homebrew (Milestone M7)

Note

Homebrew tap is planned for Milestone M7. Subscribe to issue #10 for updates.

Preview command (not yet available):

brew install mendsec/tap/catnet

Shell Completions

Bash

catnet completion bash > /etc/bash_completion.d/catnet
# or for user-level:
mkdir -p ~/.local/share/bash-completion/completions
catnet completion bash > ~/.local/share/bash-completion/completions/catnet

Zsh

catnet completion zsh > "${fpath[1]}/_catnet"
# or add to ~/.zshrc:
mkdir -p ~/.zsh/completion
catnet completion zsh > ~/.zsh/completion/_catnet
echo 'fpath=(~/.zsh/completion $fpath)' >> ~/.zshrc

Fish

catnet completion fish > ~/.config/fish/completions/catnet.fish

PowerShell

catnet completion powershell > $PROFILE
# or to a specific script:
catnet completion powershell > catnet-completion.ps1

Restart your shell after installing completion scripts.

Upgrading

  • Binary: re-run the install step; binaries are statically linked and overwrite cleanly.
  • go install: re-run with the new @vX.Y.Z tag.

Clone this wiki locally