Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/lissy93/adguardian-term/llms.txt

Use this file to discover all available pages before exploring further.

AdGuardian Term is an unofficial, open-source terminal UI for AdGuard Home. It connects to your AdGuard Home instance and renders a real-time, interactive dashboard directly in your terminal — no browser required. Built in Rust using ratatui, it’s fast, lightweight, and ships as a single static binary.

Installation

Install via Docker, Cargo, binary download, or the one-liner quick-start script.

Quickstart

Get AdGuardian running against your AdGuard Home instance in under two minutes.

Configuration

Set connection details, refresh intervals, and query log limits via env vars or flags.

Deployment

Run in Docker, expose via a browser with web mode, or compile from source.

​
What AdGuardian Shows You

AdGuardian renders a multi-panel dashboard that updates at a configurable interval (default: every 2 seconds):
  • Status panel — AdGuard Home version, DNS/HTTP ports, protection state, DHCP availability, and average query processing time
  • Block rate gauge — percentage of queries blocked across all filter categories
  • 30-day history chart — time-series line chart of total DNS queries vs. blocked queries
  • Live query table — scrollable table of recent DNS queries with client, domain, type, reason, upstream, latency, and cache status
  • Filter list — active AdGuard filter lists with rule counts
  • Top domains & clients — ranked lists of top queried domains, top blocked domains, and top client IPs

​
Getting Started

1

Install AdGuardian

Pick any installation method — Docker is the quickest, Cargo is easiest if you have Rust installed.
# Docker
docker run -it lissy93/adguardian

# Cargo
cargo install adguardian
2

Provide your AdGuard Home credentials

Pass your AdGuard Home IP, port, username, and password. AdGuardian will prompt for any missing values interactively.
ADGUARD_IP="192.168.1.1" \
ADGUARD_PORT="3000" \
ADGUARD_USERNAME="admin" \
ADGUARD_PASSWORD="yourpassword" \
adguardian
3

Watch your network in real time

AdGuardian connects, verifies your credentials, and opens the live dashboard. Press q or Ctrl+C to exit.
AdGuardian requires AdGuard Home v0.107.29 or later. It will print an error and exit if your instance is running an older version.

Build docs developers (and LLMs) love

Get started for freeTalk to us