Adguard Home

# AdGuard Home Skill

🛡️ Query AdGuard Home instances for DNS statistics, blocked domains, and client activity  
🛡️ 查询 AdGuard Home 实例的 DNS 统计、拦截域名和客户端活动

---

## Features | 功能特性

- ✅ Multi-instance support | 支持多实例配置
- ✅ Real-time DNS query statistics | 实时 DNS 查询统计
- ✅ Blocked domains leaderboard | 拦截域名排行
- ✅ Active client analysis | 活跃客户端分析
- ✅ Health status check | 健康状态检查
- ✅ Service status monitoring | 服务状态监控
- ✅ DNS configuration details | DNS 配置详情
- ✅ Filter rules inspection | 过滤规则和列表
- ✅ Recent query log | 最近查询日志
- ✅ TLS/encryption status | TLS/加密状态

---

## Installation | 安装方法

### Method 1: ClawHub CLI (Recommended) | 方法 1: ClawHub CLI（推荐）

```bash
# Install from ClawHub registry | 从 ClawHub 安装
clawhub install adguard-home

# Verify installation | 验证安装
clawhub list | grep adguard-home
```

### Method 2: Manual Install | 方法 2: 手动安装

```bash
# Clone the repository | 克隆仓库
git clone https://github.com/foxleoly/adguard-home-skill.git
cd adguard-home-skill

# Copy to your skills directory | 复制到技能目录
cp -r . ~/.openclaw/workspace/skills/adguard-home/
```

### Post-Installation Setup | 安装后配置

1. **Create configuration file | 创建配置文件:**
   ```bash
   # Edit adguard-instances.json | 编辑配置文件
   vim ~/.openclaw/workspace/adguard-instances.json
   ```

2. **Add your instances | 添加实例:**
   ```json
   {
     "instances": {
       "dns1": {
         "url": "http://192.168.1.1:80",
         "username": "admin",
         "password": "your-password"
       }
     }
   }
   ```

3. **Secure the config file | 保护配置文件:**
   ```bash
   chmod 600 ~/.openclaw/workspace/adguard-instances.json
   ```

4. **Test the skill | 测试技能:**
   ```bash
   /adguard stats dns1
   ```

---

## Usage | 使用方法

### Basic Commands | 基础命令

```bash
# Statistics & Monitoring | 统计与监控
/adguard stats [instance]           # DNS statistics | DNS 统...

# 🛡️ AdGuard Home Skill

Query AdGuard Home instances for DNS statistics, blocked domains, filter rules, and configuration.

## Features

- 📊 DNS query and blocking statistics
- 💻 Top clients ranking
- 🚫 Blocked domains leaderboard
- 🔧 Service status monitoring
- 🌐 DNS configuration details
- 🛡️ Filter rules inspection
- 📜 Recent query log
- 👥 Client management
- 🔒 TLS/encryption status
- ✅ Multi-instance support

## Installation

### Via ClawHub (Recommended)

```bash
clawhub install adguard-home
```

### Manual Installation

Copy this skill folder to your OpenClaw workspace:

```bash
cp -r skills/adguard-home ~/.openclaw/workspace/skills/
```

## Configuration

### 🔒 Security Best Practices

**⚠️ Important:** Do not store plaintext credentials in configuration files. Use environment variables or a secrets manager.

#### Option 1: Environment Variables (Recommended)

```bash
export ADGUARD_URL="http://192.168.145.249:1080"
export ADGUARD_USERNAME="admin"
export ADGUARD_PASSWORD="your-secure-password"
```

#### Option 2: 1Password CLI

```bash
export ADGUARD_PASSWORD=$(op read "op://vault/AdGuard/credential")
```

#### Option 3: Workspace Config (Local Development Only)

For local development, create `adguard-instances.json` in the skill directory:

```json
{
  "instances": {
    "dns1": {
      "url": "http://192.168.145.249:1080",
      "username": "admin",
      "password": "your-secure-password"
    }
  }
}
```

**⚠️ Never commit this file to version control. Add it to `.gitignore`.**

## Usage

```bash
# Statistics
/adguard stats [instance]
/adguard top-clients [instance]
/adguard top-blocked [instance]

# Status & Configuration
/adguard status [instance]
/adguard dns-info [instance]
/adguard filter-rules [instance]
/adguard tls-status [instance]
/adguard clients [instance]

# Query Log
/adguard querylog [instance] [limit]

# Health Check
/adguard health [instance]
```

## Examples

```bash
# Check DNS statistics
/adguard stats dns1

# View service st...