Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shuienko/phstat

Get Pi-Hole metrics remotely using command line.
https://github.com/shuienko/phstat

command-line dashboard go pi-hole statistics

Last synced: 5 days ago
JSON representation

Get Pi-Hole metrics remotely using command line.

Awesome Lists containing this project

README

        

# phstat ![Build Status](https://github.com/shuienko/phstat/actions/workflows/go.yml/badge.svg) [![Go Report Card](https://goreportcard.com/badge/github.com/shuienko/phstat)](https://goreportcard.com/report/github.com/shuienko/phstat)
Get [Pi-Hole](https://github.com/pi-hole/pi-hole) metrics remotely using command line.

## download

Get binary from [Releases](https://github.com/shuienko/phstat/releases) and save it somewhere in your `$PATH`

## or build yourself
```bash
go build -o phstat
```

## set environment variables
* get `PIHOLE_TOKEN` here http://your-pi-hole-ip/admin/settings.php?tab=api or here `/etc/pihole/setupVars.conf`
* add it to your `.bashrc` or `.zshrc`:

```bash
export PIHOLE_HOST=your-pi-hole-ip
export PIHOLE_TOKEN=longtokenstring
```

## use

```
Pi-Hole Dashboard. Docs: https://github.com/shuienko/phstat/blob/master/README.md
Usage: phstat [-h] [-n seconds]
-h show this page
-n seconds
update interval in seconds (default 2)
```

## ui example
macOC 10.13; iTerm2 app; Menlo Regular 12pt.)