adguardian-term

Terminal dashboard for AdGuard Home

TLDR

Launch the dashboard with connection details

$ ADGUARD_IP="192.168.1.1" ADGUARD_PORT="3000" ADGUARD_USERNAME="admin" ADGUARD_PASSWORD="pass" adguardian

Launch with command-line flags

$ adguardian --adguard-ip [192.168.1.1] --adguard-port [3000] --adguard-username [admin] --adguard-password [pass]

Run via Docker

$ docker run -e ADGUARD_IP=192.168.1.1 -e ADGUARD_PORT=3000 -e ADGUARD_USERNAME=admin -e ADGUARD_PASSWORD=pass -it lissy93/adguardian

adguardian-term is a terminal-based real-time traffic monitoring and statistics dashboard for AdGuard Home instances. It displays DNS query activity, block/allow statistics, active filter lists, and top queried domains in an interactive TUI. Written in Rust using ratatui for the interface, it communicates with the AdGuard Home API to provide a lightweight alternative to the web UI.The dashboard refreshes automatically and shows queries allowed, filtered, or blocked, along with historical trends and domain analytics.

PARAMETERS

--adguard-ip address

IP address of the AdGuard Home instance

--adguard-port port

Port number of the AdGuard Home instance

--adguard-username user

Authentication username

--adguard-password pass

Authentication password

CONFIGURATION

Configuration can be set via environment variables or command-line flags. Supported environment variables: ADGUARD_IP, ADGUARD_PORT, ADGUARD_USERNAME, ADGUARD_PASSWORD, ADGUARD_PROTOCOL (default: http), and ADGUARD_UPDATE_INTERVAL (default: 2 seconds).

CAVEATS

Requires a running AdGuard Home instance with API access. Credentials must be provided via environment variables or flags. The tool only communicates with the configured AdGuard Home instance and makes no other external requests.

HISTORY

adguardian-term was created by Alicia Sykes (Lissy93) and is open-source under the MIT license. It was originally written in Go and later rewritten in Rust. The project was inspired by PADD, a similar dashboard for Pi-hole.