Install gghstats
Recommended: run the installer script, set GGHSTATS_GITHUB_TOKEN, then gghstats run --open.
// Unix (macOS, Linux, FreeBSD, OpenBSD, WSL)
curl -fsSL https://get.gghstats.com/install.sh | sh
Inspect before running: curl -fsSL … -o install.sh && less install.sh
// Other installation methods
| Homebrew | brew install hrodrig/gghstats/gghstats |
| Go install | go install github.com/hrodrig/gghstats/cmd/gghstats@latest |
| Docker | docker pull ghcr.io/hrodrig/gghstats:v1.0.0 |
| GitHub Releases | .deb, .rpm, .tar.gz |
macOS first run (Gatekeeper)
Unsigned CLI binaries may show “Apple could not verify…” on the first gghstats run. This is download quarantine, not malware. Clear it once:
xattr -dr com.apple.quarantine "$(command -v gghstats)"
Or use System Settings → Privacy & Security → Open Anyway. Updated Homebrew casks clear quarantine on install.
// Getting started
$ curl -fsSL https://get.gghstats.com/install.sh | sh $ export GGHSTATS_GITHUB_TOKEN=ghp_xxx $ gghstats run --open
`run` is an alias for `serve`; `--open` opens the browser when the dashboard is ready. Background sync starts automatically.
Optional: generate config from the CLI instead of hand-editing env vars.
$ gghstats --print-sample-config > ./gghstats.env # adjust $ export GGHSTATS_GITHUB_TOKEN=ghp_xxx $ gghstats run --open
Same flow as the homepage quick start. Configuration and token setup in theREADME.