Documentation

Install

Get the pysar binary on your PATH, then go to Init a project.

Recommended: install script (macOS / Linux)

curl -fsSL https://getpysar.com/install.sh | bash

Prefer to read the script before running it:

curl -fsSL https://getpysar.com/install.sh -o install.sh # inspect install.sh, then: bash install.sh

The script detects darwin/linux and amd64/arm64, downloads the matching .tar.gz from the latest GitHub release, and installs to the first writable directory among:

  1. ~/.local/bin
  2. /usr/local/bin

If the chosen directory is not on your PATH, the script prints the export PATH=... line to add to your shell profile.

After a successful install, the script sends a best-effort anonymous hit to an Umami tracking pixel (platform string only — no hostname or account data). This counts install-script successes, not go install or Windows zip. It never fails the install if the pixel is unreachable. Opt out:

PYSAR_NO_TELEMETRY=1 bash install.sh

Confirm:

pysar --version pysar --help

Windows

Download the Windows .zip for your architecture from the latest release, extract pysar.exe, and place it on your PATH. The install script does not support Windows.

Build from source

Requires Go matching the version in go.mod:

git clone https://github.com/malyshev/pysar.git cd pysar go build -o pysar ./cmd/pysar # optional: install into $(go env GOPATH)/bin go install ./cmd/pysar

If you already have an older pysar earlier on PATH (for example ~/.local/bin vs ~/go/bin), check which one wins with which pysar and pysar --version.

Next

Scaffold a writing project with pysar init.