Archive/geoip/configuration.md

# 配置说明

## 总览

本项目使用的配置文件格式为 `json`，其中包含 `input` 和 `output` 两个数组，每个数组包含一个或多个输入或输出格式的具体配置。

```json
{
  "input":  [],
  "output": []
}
```

## 支持的输入或输出格式

支持的 `input` 输入格式：

- **clashRuleSet**：ipcidr 类型的 Clash RuleSet
- **clashRuleSetClassical**：classical 类型的 Clash RuleSet
- **cutter**：用于裁剪前置步骤中的数据
- **dbipCountryMMDB**：DB-IP country mmdb 数据格式（`dbip-country-lite.mmdb`）
- **ipinfoCountryMMDB**：IPInfo country mmdb 数据格式（`country.mmdb`）
- **json**：JSON 数据格式
- **maxmindGeoLite2ASNCSV**：MaxMind GeoLite2 ASN CSV 数据格式（`GeoLite2-ASN-CSV.zip`）
- **maxmindGeoLite2CountryCSV**：MaxMind GeoLite2 country CSV 数据格式（`GeoLite2-Country-CSV.zip`）
- **maxmindMMDB**：MaxMind GeoLite2 country mmdb 数据格式（`GeoLite2-Country.mmdb`）
- **mihomoMRS**：mihomo MRS 数据格式（`geoip-cn.mrs`）
- **private**：局域网和私有网络 CIDR（例如：`192.168.0.0/16` 和 `127.0.0.0/8`）
- **singboxSRS**：sing-box SRS 数据格式（`geoip-cn.srs`）
- **stdin**：从 standard input 获取纯文本 IP 和 CIDR（例如：`1.1.1.1` 或 `1.0.0.0/24`）
- **surgeRuleSet**：Surge RuleSet
- **text**：纯文本 IP 和 CIDR（例如：`1.1.1.1` 或 `1.0.0.0/24`）
- **v2rayGeoIPDat**：V2Ray GeoIP dat 数据格式（`geoip.dat`）

支持的 `output` 输出格式：

- **clashRuleSet**：ipcidr 类型的 Clash RuleSet
- **clashRuleSetClassical**：classical 类型的 Clash RuleSet
- **dbipCountryMMDB**：DB-IP country mmdb 数据格式（`dbip-country-lite.mmdb`）
- **ipinfoCountryMMDB**：IPInfo country mmdb 数据格式（`country.mmdb`）
- **lookup**：从指定的列表中查找指定的 IP 或 CIDR
- **maxmindMMDB**：MaxMind GeoLite2 country mmdb 数据格式（`GeoLite2-Country.mmdb`）
- **mihomoMRS**：mihomo MRS 数据格式（`geoip-cn.mrs`）
- **singboxSRS**：sing-box SRS 数据格式（`geoip-cn.srs`）
- **stdout**：将纯文本 CIDR 输出到 standard output（例如：`1.0.0.0/24`）
- **surgeRuleSet**：Surge RuleSet
- **text**：纯文本 CIDR（例如：`1.0.0.0/24`）
- **v2rayGeoIPDat**：V2Ray GeoIP dat 数据格式（`geoip.dat`）

## `input` 输入格式配置项

### **clashRuleSet**

- **type**：（必须）输入格式的名称
- **action**：（必须）操作类型，值为 `add`（添加 IP 地址）或 `remove`（移除 IP 地址）
- **args**：（必须）
  - **name**：类别名称。（不能与 `inputDir` 同时使用；需要与 `uri` 同时使用）
  - **uri**：Clash `ipcidr` 类型的 ruleset 文件路径，可为本地文件路径或远程 `http`、`https` 文件 URL。（不能与 `inputDir` 同时使用；需要与 `name` 同时使用）
  - **inputDir**：需要遍历的输入目录（不遍历子目录）。（遍历的文件名作为类别名称；不能与 `name` 和 `uri` 同时使用）
  - **wantedList**：（可选，数组）指定需要的类别/文件。（与 `inputDir` 同时使用）
  - **onlyIPType**：（可选）只处理的 IP 地址类型，值为 `ipv4` 或 `ipv6`。

```jsonc
{
  "type": "clashRuleSet",
  "action": "add",     // 添加 IP 地址
  "args": {
    "name": "cn",
    "uri": "./cn.yaml" // 读取本地文件 cn.yaml 的 IPv4 和 IPv6 地址，并添加到 cn 类别中
  }
}
```

```jsonc
{
  "type": "clashRuleSet",
  "action": "add",                    // 添加 IP 地址
  "args": {
    "inputDir": "./clash/yaml",       // 遍历 ./clash/yaml 目录内的所有文件（不遍历子目录）
    "wantedList": ["cn", "us", "jp"], // 只需要 ./clash/yaml 目录内文件名去除扩展名后，名为 cn、us、jp 的文件
    "onlyIPType": "ipv6"              // 只添加 IPv6 地址
  }
}
```

```jsonc
{
  "type": "clashRuleSet",
  "action": "remove",                     // 移除 IP 地址
  "args": {
    "name": "cn",
    "uri": "https://example.com/cn.yaml", // 读取网络文件内容
    "onlyIPType": "ipv6"                  // 只从 cn 类别中移除 IPv6 地址
  }
}
```

### **clashRuleSetClassical**

- **type**：（必须）输入格式的名称
- **action**：（必须）操作类型，值为 `add`（添加 IP 地址）或 `remove`（移除 IP 地址）
- **args**：（必须）
  - **name**：类别名称。（不能与 `inputDir` 同时使用；需要与 `uri` 同时使用）
  - **uri**：Clash `classical` 类型的 ruleset 文件路径，可为本地文件路径或远程 `http`、`https` 文件 URL。（不能与 `inputDir` 同时使用；需要与 `name` 同时使用）
  - **inputDir**：需要遍历的输入目录（不遍历子目录）。（遍历的文件名作为类别名称；不能与 `name` 和 `uri` 同时使用）
  - **wantedList**：（可选，数组）指定需要的类别/文件。（与 `inputDir` 同时使用）
  - **onlyIPType**：（可选）只处理的 IP 地址类型，值为 `ipv4` 或 `ipv6`。

```jsonc
{
  "type": "clashRuleSetClassical",
  "action": "add",     // 添加 IP 地址
  "args": {
    "name": "cn",
    "uri": "./cn.yaml" // 读取本地文件 cn.yaml 的 IPv4 和 IPv6 地址，并添加到 cn 类别中
  }
}
```

```jsonc
{
  "type": "clashRuleSetClassical",
  "action": "add",                    // 添加 IP 地址
  "args": {
    "inputDir": "./clash/yaml",       // 遍历 ./clash/yaml 目录内的所有文件（不遍历子目录）
    "wantedList": ["cn", "us", "jp"], // 只需要 ./clash/yaml 目录内文件名去除扩展名后，名为 cn、us、jp 的文件
    "onlyIPType": "ipv6"              // 只添加 IPv6 地址
  }
}
```

```jsonc
{
  "type": "clashRuleSetClassical",
  "action": "remove",                     // 移除 IP 地址
  "args": {
    "name": "cn",
    "uri": "https://example.com/cn.yaml", // 读取网络文件内容
    "onlyIPType": "ipv6"                  // 只从 cn 类别中移除 IPv6 地址
  }
}
```

### **cutter**

- **type**：（必须）输入格式的名称
- **action**：（必须）操作类型，值只能是 `remove`（移除 IP 地址）
- **args**：（必须）
  - **wantedList**：（必须，数组）指定需要的类别/文件。
  - **onlyIPType**：（可选）只处理的 IP 地址类型，值为 `ipv4` 或 `ipv6`。

```jsonc
{
  "type": "cutter",
  "action": "remove",                // 移除 IP 地址
  "args": {
    "wantedList": ["cn", "us", "jp"] // 移除名为 cn、us、jp 这三个类别的 IPv4 和 IPv6 地址，即删除这三个类别
  }
}
```

```jsonc
{
  "type": "cutter",
  "action": "remove",                 // 移除 IP 地址
  "args": {
    "wantedList": ["cn", "us", "jp"],
    "onlyIPType": "ipv6"              // 只移除名为 cn、us、jp 这三个类别的 IPv6 地址
  }
}
```

### **dbipCountryMMDB**

- **type**：（必须）输入格式的名称
- **action**：（必须）操作类型，值为 `add`（添加 IP 地址）或 `remove`（移除 IP 地址）
- **args**：（可选）
  - **uri**：（可选）DB-IP country MMDB 格式文件路径，可为本地文件路径或远程 `http`、`https` 文件 URL。
  - **wantedList**：（可选）指定需要的类别/文件。
  - **onlyIPType**：（可选）只处理的 IP 地址类型，值为 `ipv4` 或 `ipv6`。

```jsonc
// 默认使用文件：
// ./db-ip/dbip-country-lite.mmdb
{
  "type": "dbipCountryMMDB",
  "action": "add"       // 添加 IP 地址
}
```

```jsonc
{
  "type": "dbipCountryMMDB",
  "action": "add",       // 添加 IP 地址
  "args": {
    "uri": "./db-ip/dbip-country-lite.mmdb"
  }
}
```

```jsonc
{
  "type": "dbipCountryMMDB",
  "action": "add",                        // 添加 IP 地址
  "args": {
    "uri": "https://example.com/my.mmdb",
    "wantedList": ["cn", "us", "jp"],    // 只需要名为 cn、us、jp 的类别
    "onlyIPType": "ipv4"                 // 只添加 IPv4 地址
  }
}
```

```jsonc
{
  "type": "dbipCountryMMDB",
  "action": "remove",                    // 添加 IP 地址
  "args": {
    "uri": "https://example.com/my.mmdb",
    "wantedList": ["cn", "us", "jp"],    // 只移除名为 cn、us、jp 这三个类别的 IPv4 地址
    "onlyIPType": "ipv4"                 // 只移除 IPv4 地址
  }
}
```

### **ipinfoCountryMMDB**

- **type**：（必须）输入格式的名称
- **action**：（必须）操作类型，值为 `add`（添加 IP 地址）或 `remove`（移除 IP 地址）
- **args**：（可选）
  - **uri**：（可选）IPInfo country MMDB 格式文件路径，可为本地文件路径或远程 `http`、`https` 文件 URL。
  - **wantedList**：（可选）指定需要的类别/文件。
  - **onlyIPType**：（可选）只处理的 IP 地址类型，值为 `ipv4` 或 `ipv6`。

```jsonc
// 默认使用文件：
// ./ipinfo/country.mmdb
{
  "type": "ipinfoCountryMMDB",
  "action": "add"       // 添加 IP 地址
}
```

```jsonc
{
  "type": "ipinfoCountryMMDB",
  "action": "add",       // 添加 IP 地址
  "args": {
    "uri": "./ipinfo/country.mmdb"
  }
}
```

```jsonc
{
  "type": "ipinfoCountryMMDB",
  "action": "add",                        // 添加 IP 地址
  "args": {
    "uri": "https://example.com/my.mmdb",
    "wantedList": ["cn", "us", "jp"],    // 只需要名为 cn、us、jp 的类别
    "onlyIPType": "ipv4"                 // 只添加 IPv4 地址
  }
}
```

```jsonc
{
  "type": "ipinfoCountryMMDB",
  "action": "remove",                    // 添加 IP 地址
  "args": {
    "uri": "https://example.com/my.mmdb",
    "wantedList": ["cn", "us", "jp"],    // 只移除名为 cn、us、jp 这三个类别的 IPv4 地址
    "onlyIPType": "ipv4"                 // 只移除 IPv4 地址
  }
}
```

### **json**

- **type**：（必须）输入格式的名称
- **action**：（必须）操作类型，值为 `add`（添加 IP 地址）或 `remove`（移除 IP 地址）
- **args**：（必须）
  - **name**：类别名称。（不能与 `inputDir` 同时使用；需要与 `uri` 同时使用）
  - **uri**：JSON 文件路径，可为本地文件路径或远程 `http`、`https` 文件 URL。（不能与 `inputDir` 同时使用；需要与 `name` 同时使用）
  - **inputDir**：需要遍历的输入目录（不遍历子目录）。（遍历的文件名作为类别名称；不能与 `name` 和 `uri` 同时使用）
  - **wantedList**：（可选，数组）指定需要的类别/文件。
  - **onlyIPType**：（可选）只处理的 IP 地址类型，值为 `ipv4` 或 `ipv6`。
  - **jsonPath**：（必须，数组）项目 [@tidwall/gjson](https://github.com/tidwall/gjson) 定义的 JSON 数据读取路径，用于从 JSON 格式数据中提取需要的 IPv4 地址 和 IPv6 地址，语法参考：[https://github.com/tidwall/gjson/blob/master/SYNTAX.md](https://github.com/tidwall/gjson/blob/master/SYNTAX.md)

```jsonc
{
  "type": "json",
  "action": "add", // 添加 IP 地址
  "args": {
    "name": "fastly",
    "uri": "https://api.fastly.com/public-ip-list",
    "jsonPath": ["addresses", "ipv6_addresses"]
  }
}
```

```jsonc
{
  "type": "json",
  "action": "add",                    // 添加 IP 地址
  "args": {
    "inputDir": "./json",
    "wantedList": ["cn", "us", "jp"], // 只需要 ./json 目录内文件名去除扩展名后，名为 cn、us、jp 的 JSON 文件
    "onlyIPType": "ipv6",             // 只添加 IPv6 地址
    "jsonPath": ["prefixes.#.ipv4Prefix", "prefixes.#.ipv6Prefix"]
  }
}
```

```jsonc
{
  "type": "json",
  "action": "remove",     // 移除 IP 地址
  "args": {
    "name": "cn",
    "uri": "./cn.json",
    "onlyIPType": "ipv6", // 只移除类别为 cn 的 IPv6 地址
    "jsonPath": ["prefixes.#.ipv4Prefix", "prefixes.#.ipv6Prefix"]
  }
}
```

### **maxmindGeoLite2ASNCSV**

- **type**：（必须）输入格式的名称
- **action**：（必须）操作类型，值为 `add`（添加 IP 地址）或 `remove`（移除 IP 地址）
- **args**：（可选）
  - **ipv4**：（可选）MaxMind GeoLite2 ASN IPv4 文件路径（`GeoLite2-ASN-Blocks-IPv4.csv`），可为本地文件路径或远程 `http`、`https` 文件 URL。
  - **ipv6**：（可选）MaxMind GeoLite2 ASN IPv6 文件路径（`GeoLite2-ASN-Blocks-IPv6.csv`），可为本地文件路径或远程 `http`、`https` 文件 URL。
  - **wantedList**：（可选，数组或对象；当为数组时，值为 ASN 字符串；当为对象时，键为类别名，值为 ASN 字符串数组）指定 ASN 或类别名及其包含的 ASN。若未指定，则默认选择所有 ASN。
  - **onlyIPType**：（可选）只处理的 IP 地址类型，值为 `ipv4` 或 `ipv6`。

```jsonc
// 默认使用文件：
// ./geolite2/GeoLite2-ASN-Blocks-IPv4.csv
// ./geolite2/GeoLite2-ASN-Blocks-IPv6.csv
{
  "type": "maxmindGeoLite2ASNCSV",
  "action": "add",                                   // 添加 IP 地址
  "args": {
    "wantedList": {
      "facebook": ["AS63293", "AS54115", "AS32934"], // 将隶属于 ASN 的 IPv4 地址 和 IPv6 地址添加到 facebook 类别中
      "fastly":   ["AS54113", "AS394192"]            // 将隶属于 ASN 的 IPv4 地址 和 IPv6 地址添加到 fastly 类别中
    }
  }
}
```

```jsonc
{
  "type": "maxmindGeoLite2ASNCSV",
  "action": "remove",                                   // 移除 IP 地址
  "args": {
    "ipv4": "./geolite2/GeoLite2-ASN-Blocks-IPv4.csv",
    "ipv6": "./geolite2/GeoLite2-ASN-Blocks-IPv6.csv",    
    "wantedList": {
      "facebook": ["AS63293", "AS54115", "AS32934"],   // 从 facebook 类别中移除隶属于 ASN 的 IPv6 地址
      "fastly":   ["AS54113", "AS394192"]              // 从 fastly 类别中移除隶属于 ASN 的 IPv6 地址
    },
    "onlyIPType": "ipv6"                               // 只移除 IPv6 地址
  }
}
```

```jsonc
// 由于未指定 `wantedList`，自动将所有 ASN 添加为类别，类别名格式为 AS + ASN 字符串，如 `AS123`、`AS12345`
{
  "type": "maxmindGeoLite2ASNCSV",
  "action": "add"                   // 添加 IP 地址
}
```

```jsonc
// 由于未指定 `wantedList`，自动将所有 ASN 添加为类别，类别名格式为 AS + ASN 字符串，如 `AS123`、`AS12345`
{
  "type": "maxmindGeoLite2ASNCSV",
  "action": "add",                  // 添加 IP 地址
  "args": {
    "onlyIPType": "ipv4"            // 只添加各自的 IPv4 地址
  }
}
```

```jsonc
// 由于未指定 `wantedList`，自动移除所有匹配的 ASN 类别，匹配的类别名格式为 AS + ASN 字符串，如 `AS123`、`AS12345`
{
  "type": "maxmindGeoLite2ASNCSV",
  "action": "remove"                // 移除 IP 地址
}
```

```jsonc
{
  "type": "maxmindGeoLite2ASNCSV",
  "action": "add",                     // 添加 IP 地址
  "args": {
    "wantedList": ["AS123", "AS4567"]  // 向名为 AS123 和 AS4567 的类别中分别添加各自的 IPv4 和 IPv6 地址
  }
}
```

```jsonc
{
  "type": "maxmindGeoLite2ASNCSV",
  "action": "remove",                   // 移除 IP 地址
  "args": {
    "wantedList": ["AS123", "AS4567"],  // 从名为 AS123 和 AS4567 的类别中分别移除各自的 IPv6 地址
    "onlyIPType": "ipv6"
  }
}
```

### **maxmindGeoLite2CountryCSV**

- **type**：（必须）输入格式的名称
- **action**：（必须）操作类型，值为 `add`（添加 IP 地址）或 `remove`（移除 IP 地址）
- **args**：（可选）
  - **country**：（可续）MaxMind GeoLite2 Country CSV location 文件路径（`GeoLite2-Country-Locations-en.csv`），可为本地文件路径或远程 `http`、`https` 文件 URL。
  - **ipv4**：（可选）MaxMind GeoLite2 Country IPv4 文件路径（`GeoLite2-Country-Blocks-IPv4.csv`），可为本地文件路径或远程 `http`、`https` 文件 URL。
  - **ipv6**：（可选）MaxMind GeoLite2 Country IPv6 文件路径（`GeoLite2-Country-Blocks-IPv6.csv`），可为本地文件路径或远程 `http`、`https` 文件 URL。
  - **wantedList**：（可选）指定需要的类别/文件。
  - **onlyIPType**：（可选）只处理的 IP 地址类型，值为 `ipv4` 或 `ipv6`。

```jsonc
// 默认使用文件：
// ./geolite2/GeoLite2-Country-Locations-en.csv
// ./geolite2/GeoLite2-Country-Blocks-IPv4.csv
// ./geolite2/GeoLite2-Country-Blocks-IPv6.csv
{
  "type": "maxmindGeoLite2CountryCSV",
  "action": "add" // 添加 IP 地址
}
```

```jsonc
{
  "type": "maxmindGeoLite2CountryCSV",
  "action": "add",                     // 添加 IP 地址
  "args": {
    "country": "./geolite2/GeoLite2-Country-Locations-en.csv",
    "ipv4": "./geolite2/GeoLite2-Country-Blocks-IPv4.csv",
    "ipv6": "./geolite2/GeoLite2-Country-Blocks-IPv6.csv"
  }
}
```

```jsonc
{
  "type": "maxmindGeoLite2CountryCSV",
  "action": "add",                   // 添加 IP 地址
  "args": {
    "wantedList": ["cn", "us", "jp"] // 只需要添加名为 cn、us、jp 的这三个类别的 IPv4 地址 和 IPv6 地址
  }
}
```

```jsonc
{
  "type": "maxmindGeoLite2CountryCSV",
  "action": "remove",                 // 移除 IP 地址
  "args": {  
    "wantedList": ["cn", "us", "jp"], // 只移除名为 cn、us、jp 的这三个类别的 IPv6 地址
    "onlyIPType": "ipv6"              // 只移除 IPv6 地址
  }
}
```

### **maxmindMMDB**

- **type**：（必须）输入格式的名称
- **action**：（必须）操作类型，值为 `add`（添加 IP 地址）或 `remove`（移除 IP 地址）
- **args**：（可选）
  - **uri**：（可选）MaxMind GeoLite2 Country mmdb 格式文件路径，可为本地文件路径或远程 `http`、`https` 文件 URL。
  - **wantedList**：（可选）指定需要的类别/文件。
  - **onlyIPType**：（可选）只处理的 IP 地址类型，值为 `ipv4` 或 `ipv6`。

```jsonc
// 默认使用文件：
// ./geolite2/GeoLite2-Country.mmdb
{
  "type": "maxmindMMDB",
  "action": "add"       // 添加 IP 地址
}
```

```jsonc
{
  "type": "maxmindMMDB",
  "action": "add",       // 添加 IP 地址
  "args": {
    "uri": "./geolite2/GeoLite2-Country.mmdb"
  }
}
```

```jsonc
{
  "type": "maxmindMMDB",
  "action": "add",                        // 添加 IP 地址
  "args": {
    "uri": "https://example.com/my.mmdb",
    "wantedList": ["cn", "us", "jp"],    // 只需要名为 cn、us、jp 的类别
    "onlyIPType": "ipv4"                 // 只添加 IPv4 地址
  }
}
```

```jsonc
{
  "type": "maxmindMMDB",
  "action": "remove",                    // 添加 IP 地址
  "args": {
    "uri": "https://example.com/my.mmdb",
    "wantedList": ["cn", "us", "jp"],    // 只移除名为 cn、us、jp 这三个类别的 IPv4 地址
    "onlyIPType": "ipv4"                 // 只移除 IPv4 地址
  }
}
```

### **mihomoMRS**

- **type**：（必须）输入格式的名称
- **action**：（必须）操作类型，值为 `add`（添加 IP 地址）或 `remove`（移除 IP 地址）
- **args**：（必须）
  - **name**：类别名称。（不能与 `inputDir` 同时使用；需要与 `uri` 同时使用）
  - **uri**：mihomo MRS 格式文件路径，可为本地文件路径或远程 `http`、`https` 文件 URL。（不能与 `inputDir` 同时使用；需要与 `name` 同时使用）
  - **inputDir**：需要遍历的输入目录（不遍历子目录）。（遍历的文件名作为类别名称;不能与 `name` 和 `uri` 同时使用）
  - **wantedList**：（可选，数组）指定需要的类别/文件。（与 `inputDir` 同时使用）
  - **onlyIPType**：（可选）只处理的 IP 地址类型，值为 `ipv4` 或 `ipv6`。

```jsonc
{
  "type": "mihomoMRS",
  "action": "add",    // 添加 IP 地址
  "args": {
    "name": "cn",
    "uri": "./cn.mrs" // 读取本地文件 cn.mrs 的 IPv4 和 IPv6 地址，并添加到 cn 类别中
  }
}
```

```jsonc
{
  "type": "mihomoMRS",
  "action": "add",                    // 添加 IP 地址
  "args": {
    "inputDir": "./mihomo/mrs",       // 遍历 ./mihomo/mrs 目录内的所有文件（不遍历子目录）
    "wantedList": ["cn", "us", "jp"], // 只需要 ./mihomo/mrs 目录里文件名去除扩展名后，名为 cn、us、jp 的文件
    "onlyIPType": "ipv6"              // 只添加 IPv6 地址
  }
}
```

```jsonc
{
  "type": "mihomoMRS",
  "action": "remove",                    // 移除 IP 地址
  "args": {
    "name": "cn",
    "uri": "https://example.com/cn.mrs", // 读取网络文件内容
    "onlyIPType": "ipv6"                 // 只从 cn 类别中移除 IPv6 地址
  }
}
```

### **private**

- **type**：（必须）输入格式的名称
- **action**：（必须）操作类型，值为 `add`（添加 IP 地址）或 `remove`（移除 IP 地址）
- **args**：（可选）
  - **onlyIPType**：（可选）只处理的 IP 地址类型，值为 `ipv4` 或 `ipv6`

> `private` 默认添加或移除的 CIDR 地址，见 [private.go](https://github.com/Loyalsoldier/geoip/blob/HEAD/plugin/special/private.go#L16-L36)

```jsonc
{
  "type": "private",
  "action": "add"   // 添加 IP 地址
}
```

```jsonc
{
  "type": "private",
  "action": "remove" // 移除 IP 地址
}
```

```jsonc
{
  "type": "private",
  "action": "add",       // 添加 IP 地址
  "args": {
    "onlyIPType": "ipv4" // 只添加 IPv4 地址
  }
}
```

```jsonc
{
  "type": "private",
  "action": "remove",    // 移除 IP 地址
  "args": {
    "onlyIPType": "ipv6" // 只移除 IPv6 地址
  }
}
```

### **singboxSRS**

- **type**：（必须）输入格式的名称
- **action**：（必须）操作类型，值为 `add`（添加 IP 地址）或 `remove`（移除 IP 地址）
- **args**：（必须）
  - **name**：类别名称。（不能与 `inputDir` 同时使用；需要与 `uri` 同时使用）
  - **uri**：sing-box SRS 格式文件路径，可为本地文件路径或远程 `http`、`https` 文件 URL。（不能与 `inputDir` 同时使用；需要与 `name` 同时使用）
  - **inputDir**：需要遍历的输入目录（不遍历子目录）。（遍历的文件名作为类别名称；不能与 `name` 和 `uri` 同时使用）
  - **wantedList**：（可选，数组）指定需要的类别/文件。（与 `inputDir` 同时使用）
  - **onlyIPType**：（可选）只处理的 IP 地址类型，值为 `ipv4` 或 `ipv6`。

```jsonc
{
  "type": "singboxSRS",
  "action": "add",    // 添加 IP 地址
  "args": {
    "name": "cn",
    "uri": "./cn.srs" // 读取本地文件 cn.srs 的 IPv4 和 IPv6 地址，并添加到 cn 类别中
  }
}
```

```jsonc
{
  "type": "singboxSRS",
  "action": "add",                    // 添加 IP 地址
  "args": {
    "inputDir": "./singbox/srs",      // 遍历 ./singbox/srs 目录内的所有文件（不遍历子目录）
    "wantedList": ["cn", "us", "jp"], // 只需要 ./singbox/srs 目录内文件名去除扩展名后，名为 cn、us、jp 的文件
    "onlyIPType": "ipv6"              // 只添加 IPv6 地址
  }
}
```

```jsonc
{
  "type": "singboxSRS",
  "action": "remove",                    // 移除 IP 地址
  "args": {
    "name": "cn",
    "uri": "https://example.com/cn.srs", // 读取网络文件内容
    "onlyIPType": "ipv6"                 // 只从 cn 类别中移除 IPv6 地址
  }
}
```

### **stdin**

- **type**：（必须）输入格式的名称
- **action**：（必须）操作类型，值为 `add`（添加 IP 地址）或 `remove`（移除 IP 地址）
- **args**：（必须）
  - **name**：（必须）类别名称
  - **onlyIPType**：（可选）只处理的 IP 地址类型，值为 `ipv4` 或 `ipv6`

```jsonc
{
  "type": "stdin",
  "action": "add", // 添加 IP 地址
  "args": {
    "name": "cn"
  }
}
```

```jsonc
{
  "type": "stdin",
  "action": "add",       // 添加 IP 地址
  "args": {
    "name": "cn",
    "onlyIPType": "ipv6" // 只添加 IPv6 地址
  }
}
```

### **surgeRuleSet**

- **type**：（必须）输入格式的名称
- **action**：（必须）操作类型，值为 `add`（添加 IP 地址）或 `remove`（移除 IP 地址）
- **args**：（必须）
  - **name**：类别名称。（不能与 `inputDir` 同时使用；需要与 `uri` 同时使用）
  - **uri**：Surge ruleset 文件路径，可为本地文件路径或远程 `http`、`https` 文件 URL。（不能与 `inputDir` 同时使用；需要与 `name` 同时使用）
  - **inputDir**：需要遍历的输入目录（不遍历子目录）。（遍历的文件名作为类别名称；不能与 `name` 和 `uri` 同时使用）
  - **wantedList**：（可选，数组）指定需要的类别/文件。（与 `inputDir` 同时使用）
  - **onlyIPType**：（可选）只处理的 IP 地址类型，值为 `ipv4` 或 `ipv6`。

```jsonc
{
  "type": "surgeRuleSet",
  "action": "add",       // 添加 IP 地址
  "args": {
    "name": "cn",
    "uri": "./cn.txt"   // 读取本地文件 cn.txt 的 IPv4 和 IPv6 地址，并添加到 cn 类别中
  }
}
```

```jsonc
{
  "type": "surgeRuleSet",
  "action": "add",                    // 添加 IP 地址
  "args": {
    "inputDir": "./surge",            // 遍历 ./surge 目录内的所有文件（不遍历子目录）
    "wantedList": ["cn", "us", "jp"], // 只需要 ./surge 目录内文件名去除扩展名后，名为 cn、us、jp 的文件
    "onlyIPType": "ipv6"              // 只添加 IPv6 地址
  }
}
```

```jsonc
{
  "type": "surgeRuleSet",
  "action": "remove",                    // 移除 IP 地址
  "args": {
    "name": "cn",
    "uri": "https://example.com/cn.txt", // 读取网络文件内容
    "onlyIPType": "ipv6"                 // 只从 cn 类别中移除 IPv6 地址
  }
}
```

### **text**

- **type**：（必须）输入格式的名称
- **action**：（必须）操作类型，值为 `add`（添加 IP 地址）或 `remove`（移除 IP 地址）
- **args**：（必须）
  - **name**：（可选）类别名称。（不能与 `inputDir` 同时使用；需要与 `uri` 或 `ipOrCIDR` 同时使用）
  - **uri**：（可选）纯文本 txt 文件路径，可为本地文件路径或远程 `http`、`https` 文件 URL。（不能与 `inputDir` 同时使用；需要与 `name` 同时使用；可与 `ipOrCIDR` 同时使用）
  - **ipOrCIDR**：（可选，数组）纯文本 IP 地址或 CIDR。（不能与 `inputDir` 同时使用；需要与 `name` 同时使用；可与 `uri` 同时使用）
  - **inputDir**：（可选）需要遍历的输入目录（不遍历子目录）。（遍历的文件名作为类别名称；不能与 `name`、`uri` 和 `ipOrCIDR` 同时使用）
  - **wantedList**：（可选，数组）指定需要的文件。（与 `inputDir` 同时使用）
  - **onlyIPType**：（可选）只处理的 IP 地址类型，值为 `ipv4` 或 `ipv6`
  - **removePrefixesInLine**：（可选，数组）每一行需要移除的字符串前缀
  - **removeSuffixesInLine**：（可选，数组）每一行需要移除的字符串后缀

```jsonc
{
  "type": "text",
  "action": "add",                                 // 添加 IP 地址
  "args": {
    "name": "cn",
    "uri": "./cn.txt",                            // 读取本地文件 cn.txt 的 IPv4 和 IPv6 地址，并添加到 cn 类别中
    "removePrefixesInLine": ["Host,", "IP-CIDR"], // 从读取的文件中移除多种不同的行前缀
    "removeSuffixesInLine": [",no-resolve"]       // 从读取的文件中移除行后缀
  }
}
```

```jsonc
{
  "type": "text",
  "action": "add",                        // 添加 IP 地址
  "args": {
    "name": "cn",
    "ipOrCIDR": ["1.0.0.1", "1.0.0.1/24"] // 添加 IP 或 CIDR 到 cn 类别
  }
}
```

```jsonc
{
  "type": "text",
  "action": "remove",                     // 移除 IP 地址
  "args": {
    "name": "cn",
    "ipOrCIDR": ["1.0.0.1", "1.0.0.1/24"] // 从 cn 类别移除 IP 或 CIDR
  }
}
```

```jsonc
{
  "type": "text",
  "action": "add",                        // 添加 IP 地址
  "args": {
    "name": "cn",
    "uri": "./cn.txt",                    // 读取本地文件 cn.txt 的 IPv4 和 IPv6 地址，并添加到 cn 类别中
    "ipOrCIDR": ["1.0.0.1", "1.0.0.1/24"] // 添加 IP 或 CIDR 到 cn 类别
  }
}
```

```jsonc
{
  "type": "text",
  "action": "add", // 添加 IP 地址
  "args": {
    "inputDir": "./text",                         // 遍历 ./text 目录内的所有文件（不遍历子目录）
    "wantedList": ["cn", "us", "jp"],             // 只需要 ./text 目录里文件名去除扩展名后，名为 cn、us、jp 的文件
    "onlyIPType": "ipv6",                         // 只添加 IPv6 地址
    "removePrefixesInLine": ["Host,", "IP-CIDR"], // 从读取的文件中移除多种不同的行前缀
    "removeSuffixesInLine": [",no-resolve"]       // 从读取的文件中移除行后缀
  }
}
```

```jsonc
{
  "type": "text",
  "action": "remove",                             // 移除 IP 地址
  "args": {
    "name": "cn",
    "uri": "https://example.com/cn.txt",          // 读取网络文件内容
    "onlyIPType": "ipv6",                         // 只从 cn 类别中移除 IPv6 地址
    "removePrefixesInLine": ["Host,", "IP-CIDR"], // 从读取的文件中移除多种不同的行前缀
  }
}
```

```jsonc
{
  "type": "text",
  "action": "remove",                       // 移除 IP 地址
  "args": {
    "name": "cn",
    "uri": "https://example.com/cn.txt",    // 读取网络文件内容
    "onlyIPType": "ipv6",                   // 只从 cn 类别中移除 IPv6 地址
    "removeSuffixesInLine": [",no-resolve"] // 从读取的文件中移除行后缀
  }
}
```

### **v2rayGeoIPDat**

- **type**：（必须）输入格式的名称
- **action**：（必须）操作类型，值为 `add`（添加 IP 地址）或 `remove`（移除 IP 地址）
- **args**：（必须）
  - **uri**：（必须）V2Ray dat 格式 geoip 文件路径，可为本地文件路径或远程 `http`、`https` 文件 URL。（不能与 `inputDir` 同时使用；需要与 `name` 同时使用）
  - **wantedList**：（可选，数组）指定需要的类别/文件。
  - **onlyIPType**：（可选）只处理的 IP 地址类型，值为 `ipv4` 或 `ipv6`

```jsonc
{
  "type": "v2rayGeoIPDat",
  "action": "add",         // 添加 IP 地址
  "args": {
    "uri": "./cn.dat"      // 读取本地文件 cn.dat 中的类别、IPv4 和 IPv6 地址
  }
}
```

```jsonc
{
  "type": "v2rayGeoIPDat",
  "action": "add",                    // 添加 IP 地址
  "args": {
    "uri": "./geoip.dat",             // 读取本地文件 geoip.dat 中的类别
    "wantedList": ["cn", "us", "jp"], // 只需要 geoip.dat 中名为 cn、us、jp 的类别
    "onlyIPType": "ipv6"              // 只添加 IPv6 地址
  }
}
```

```jsonc
{
  "type": "v2rayGeoIPDat",
  "action": "remove",                       // 移除 IP 地址
  "args": {
    "uri": "https://example.com/geoip.dat", // 读取网络文件内容
    "onlyIPType": "ipv6"                    // 移除所有类别的 IPv6 地址
  }
}
```

## `output` 输出格式配置项

### **clashRuleSet**

- **type**：（必须）输入格式的名称
- **action**：（必须）操作类型，值必须为 `output`
- **args**：（可选）
  - **outputDir**：（可选）输出目录
  - **outputExtension**：（可选）输出文件的扩展名
  - **wantedList**：（可选，数组）指定需要输出的类别
  - **excludedList**：（可选，数组）指定不需要输出的类别
  - **onlyIPType**：（可选）输出的 IP 地址类型，值为 `ipv4` 或 `ipv6`

```jsonc
// 默认输出目录 ./output/clash/ipcidr
{
  "type": "clashRuleSet",
  "action": "output"
}
```

```jsonc
{
  "type": "clashRuleSet",
  "action": "output",
  "args": {
    "outputDir": "./clash/ipcidr", // 输出文件到目录 ./clash/ipcidr
    "outputExtension": ".yaml"     // 输出文件的扩展名为 .yaml
  }
}
```

```jsonc
{
  "type": "clashRuleSet",
  "action": "output",
  "args": {
    "outputDir": "./clash/ipcidr",   // 输出文件到目录 ./clash/ipcidr
    "outputExtension": ".yaml",      // 输出文件的扩展名为 .yaml
    "wantedList": ["cn", "us", "jp"] // 只输出名为 cn、us、jp 这三个类别的 IPv4 和 IPv6 地址
  }
}
```

```jsonc
{
  "type": "clashRuleSet",
  "action": "output",
  "args": {
    "outputDir": "./clash/ipcidr",    // 输出文件到目录 ./clash/ipcidr
    "outputExtension": ".yaml",       // 输出文件的扩展名为 .yaml
    "wantedList": ["cn", "us", "jp"], // 只输出名为 cn、us、jp 这三个类别的 IPv4 地址
    "onlyIPType": "ipv4"
  }
}
```

```jsonc
{
  "type": "clashRuleSet",
  "action": "output",
  "args": {
    "outputDir": "./clash/ipcidr",     // 输出文件到目录 ./clash/ipcidr
    "outputExtension": ".yaml",        // 输出文件的扩展名为 .yaml
    "excludedList": ["cn", "us", "jp"] // 不输出名为 cn、us、jp 这三个类别的 IPv4 和 IPv6 地址
  }
}
```

### **clashRuleSetClassical**

- **type**：（必须）输入格式的名称
- **action**：（必须）操作类型，值必须为 `output`
- **args**：（可选）
  - **outputDir**：（可选）输出目录
  - **outputExtension**：（可选）输出文件的扩展名
  - **wantedList**：（可选，数组）指定需要输出的类别
  - **excludedList**：（可选，数组）指定不需要输出的类别
  - **onlyIPType**：（可选）输出的 IP 地址类型，值为 `ipv4` 或 `ipv6`

```jsonc
// 默认输出目录 ./output/clash/classical
{
  "type": "clashRuleSetClassical",
  "action": "output"
}
```

```jsonc
{
  "type": "clashRuleSetClassical",
  "action": "output",
  "args": {
    "outputDir": "./clash/classical", // 输出文件到目录 ./clash/classical
    "outputExtension": ".yaml"        // 输出文件的扩展名为 .yaml
  }
}
```

```jsonc
{
  "type": "clashRuleSetClassical",
  "action": "output",
  "args": {
    "outputDir": "./clash/classical", // 输出文件到目录 ./clash/classical
    "outputExtension": ".yaml",       // 输出文件的扩展名为 .yaml
    "wantedList": ["cn", "us", "jp"]  // 只输出名为 cn、us、jp 这三个类别的 IPv4 和 IPv6 地址
  }
}
```

```jsonc
{
  "type": "clashRuleSetClassical",
  "action": "output",
  "args": {
    "outputDir": "./clash/classical", // 输出文件到目录 ./clash/classical
    "outputExtension": ".yaml",       // 输出文件的扩展名为 .yaml
    "wantedList": ["cn", "us", "jp"], // 只输出名为 cn、us、jp 这三个类别的 IPv4 地址
    "onlyIPType": "ipv4"
  }
}
```

```jsonc
{
  "type": "clashRuleSetClassical",
  "action": "output",
  "args": {
    "outputDir": "./clash/classical",   // 输出文件到目录 ./clash/classical
    "outputExtension": ".yaml",         // 输出文件的扩展名为 .yaml
    "excludedList": ["cn", "us", "jp"]  // 不输出名为 cn、us、jp 这三个类别的 IPv4 和 IPv6 地址
  }
}
```

### **dbipCountryMMDB**

- **type**：（必须）输入格式的名称
- **action**：（必须）操作类型，值必须为 `output`
- **args**：（可选）
  - **outputName**：（可选）输出的文件名
  - **outputDir**：（可选）输出目录
  - **onlyIPType**：（可选）输出的 IP 地址类型，值为 `ipv4` 或 `ipv6`
  - **wantedList**：（可选，数组）指定需要输出的类别
  - **excludedList**：（可选，数组）指定不需要输出的类别
  - **overwriteList**：（可选，数组）指定最后写入的类别（原因见👇）
  - **sourceMMDBURI**：（可选）指定用于补全本项目生成的 MMDB 格式文件所缺失的额外信息的 DB-IP 官方 country MMDB 格式文件路径，可为本地文件路径或远程 `http`、`https` 文件 URL（原因见👇）

> 由于 DB-IP mmdb 文件格式的限制，当不同列表的 IP 或 CIDR 数据有交集或重复项时，后写入的列表的 IP 或 CIDR 数据会覆盖（overwrite）之前已写入的列表的数据。譬如，IP `1.1.1.1` 同属于列表 `AU` 和列表 `Cloudflare`。如果 `Cloudflare` 在 `AU` 之后写入，则 IP `1.1.1.1` 最终归属于列表 `Cloudflare`。
>
> 为了确保某些指定的列表、被修改的列表一定囊括属于它的所有 IP 或 CIDR 数据，可在 output 输出格式为 `dbipCountryMMDB` 的配置中增加选项 `overwriteList`，该选项中指定的列表会在最后逐一写入，列表中最后一项优先级最高。若已设置选项 `wantedList`，则无需设置 `overwriteList`。`wantedList` 中指定的列表会在最后逐一写入，列表中最后一项优先级最高。
>
> `wantedList`、`overwriteList`、`excludedList` 三者中，`excludedList` 优先级最高。即：若设置了选项 `excludedList`，最终不会输出存在于 `excludedList` 中的列表。

> 由于本项目软件架构的限制，默认输出的 MMDB 格式文件只包含基本信息（`country.iso_code` 字段，即国家/地区两位英文字母代号），不包含其他额外信息（如 IP 或 CIDR 所属的国家/地区多语种名称、所属大洲及大洲多语种名称等）。为了跟官方提供的 MMDB 格式文件保持同样丰富的信息（字段），可通过配置选项 `sourceMMDBURI` 来指定 DB-IP 官方 country MMDB 格式文件路径，为本项目生成的 MMDB 格式文件补全缺失的额外信息。
>
> 只能补全国家/地区类别的额外信息。新增类别不属于国家/地区类别，不存在于 DB-IP 官方 country MMDB 格式文件中，无法补全。

```jsonc
// 默认输出目录 ./output/db-ip
{
  "type": "dbipCountryMMDB",
  "action": "output"
}
```

```jsonc
{
  "type": "dbipCountryMMDB",
  "action": "output",
  "args": {
    "outputDir": "./output",                      // 输出文件到 output 目录
    "outputName": "Country-only-cn-private.mmdb", // 输出文件名为 Country-only-cn-private.mmdb
    "wantedList": ["cn", "private"]               // 只输出 cn、private 类别
  }
}
```

```jsonc
{
  "type": "dbipCountryMMDB",
  "action": "output",
  "args": {
    "outputDir": "./output",                         // 输出文件到 output 目录
    "outputName": "Country-without-cn-private.mmdb", // 输出文件名为 Country-without-cn-private.mmdb
    "excludedList": ["cn", "private"]                // 不输出 cn、private 类别
  }
}
```

```jsonc
{
  "type": "dbipCountryMMDB",
  "action": "output",
  "args": {
    "outputName": "Country.mmdb",     // 输出文件名为 Country.mmdb
    "overwriteList": ["cn", "google"] // 确保 cn、google 类别最后写入，且 google 比 cn 后写入
  }
}
```

```jsonc
{
  "type": "dbipCountryMMDB",
  "action": "output",
  "args": {
    "outputName": "Country.mmdb",      // 输出文件名为 Country.mmdb
    "overwriteList": ["cn", "google"], // 确保 cn、google 类别最后写入，且 google 比 cn 后写入
    "onlyIPType": "ipv4"               // 只输出 cn、private 类别的 IPv4 地址
  }
}
```

```jsonc
{
  "type": "dbipCountryMMDB",
  "action": "output",
  "args": {
    "outputName": "Country.mmdb",                 // 输出文件名为 Country.mmdb
    "excludedList": ["private"],                  // 最终不输出 private 类别
    "wantedList": ["private" ,"au", "cloudflare"] // 只输出 au、cloudflare 类别，并确保 cloudflare 比 au 后写入。但由于 private 存在于 excludedList 中，最终不输出 private 类别
  }
}
```

```jsonc
{
  "type": "dbipCountryMMDB",
  "action": "output",
  "args": {
    "outputName": "Country.mmdb",                // 输出文件名为 Country.mmdb
    "excludedList": ["private"],                 // 最终不输出 private 类别
    "overwriteList": ["private" ,"cn", "google"] // 确保 cn、google 类别最后写入，且 google 比 cn 后写入。但由于 private 存在于 excludedList 中，最终不输出 private 类别
  }
}
```

```jsonc
{
  "type": "dbipCountryMMDB",
  "action": "output",
  "args": {
    "outputName": "Country.mmdb",                     // 输出文件名为 Country.mmdb
    "excludedList": ["private"],                      // 最终不输出 private 类别
    "overwriteList": ["private" ,"cn", "google"],     // 确保 cn、google 类别最后写入，且 google 比 cn 后写入。但由于 private 存在于 excludedList 中，最终不输出 private 类别
    "sourceMMDBURI": "./db-ip/dbip-country-lite.mmdb" // 用于补全生成的 MMDB 格式文件额外信息的 DB-IP 官方 country MMDB 格式文件。由于 private、google 类别不属于国家/地区类别，无法补全额外信息。
  }
}
```

### **ipinfoCountryMMDB**

- **type**：（必须）输入格式的名称
- **action**：（必须）操作类型，值必须为 `output`
- **args**：（可选）
  - **outputName**：（可选）输出的文件名
  - **outputDir**：（可选）输出目录
  - **onlyIPType**：（可选）输出的 IP 地址类型，值为 `ipv4` 或 `ipv6`
  - **wantedList**：（可选，数组）指定需要输出的类别
  - **excludedList**：（可选，数组）指定不需要输出的类别
  - **overwriteList**：（可选，数组）指定最后写入的类别（原因见👇）
  - **sourceMMDBURI**：（可选）指定用于补全本项目生成的 MMDB 格式文件所缺失的额外信息的 IPInfo 官方 country MMDB 格式文件路径，可为本地文件路径或远程 `http`、`https` 文件 URL（原因见👇）

> 由于 IPInfo mmdb 文件格式的限制，当不同列表的 IP 或 CIDR 数据有交集或重复项时，后写入的列表的 IP 或 CIDR 数据会覆盖（overwrite）之前已写入的列表的数据。譬如，IP `1.1.1.1` 同属于列表 `AU` 和列表 `Cloudflare`。如果 `Cloudflare` 在 `AU` 之后写入，则 IP `1.1.1.1` 最终归属于列表 `Cloudflare`。
>
> 为了确保某些指定的列表、被修改的列表一定囊括属于它的所有 IP 或 CIDR 数据，可在 output 输出格式为 `ipinfoCountryMMDB` 的配置中增加选项 `overwriteList`，该选项中指定的列表会在最后逐一写入，列表中最后一项优先级最高。若已设置选项 `wantedList`，则无需设置 `overwriteList`。`wantedList` 中指定的列表会在最后逐一写入，列表中最后一项优先级最高。
>
> `wantedList`、`overwriteList`、`excludedList` 三者中，`excludedList` 优先级最高。即：若设置了选项 `excludedList`，最终不会输出存在于 `excludedList` 中的列表。

> 由于本项目软件架构的限制，默认输出的 MMDB 格式文件只包含基本信息（`country` 字段，即国家/地区两位英文字母代号），不包含其他额外信息（如 IP 或 CIDR 所属的国家/地区多语种名称、所属大洲及大洲多语种名称等）。为了跟官方提供的 MMDB 格式文件保持同样丰富的信息（字段），可通过配置选项 `sourceMMDBURI` 来指定 IPInfo 官方 country MMDB 格式文件路径，为本项目生成的 MMDB 格式文件补全缺失的额外信息。
>
> 只能补全国家/地区类别的额外信息。新增类别不属于国家/地区类别，不存在于 IPInfo 官方 country MMDB 格式文件中，无法补全。

```jsonc
// 默认输出目录 ./output/ipinfo
{
  "type": "ipinfoCountryMMDB",
  "action": "output"
}
```

```jsonc
{
  "type": "ipinfoCountryMMDB",
  "action": "output",
  "args": {
    "outputDir": "./output",                      // 输出文件到 output 目录
    "outputName": "Country-only-cn-private.mmdb", // 输出文件名为 Country-only-cn-private.mmdb
    "wantedList": ["cn", "private"]               // 只输出 cn、private 类别
  }
}
```

```jsonc
{
  "type": "ipinfoCountryMMDB",
  "action": "output",
  "args": {
    "outputDir": "./output",                         // 输出文件到 output 目录
    "outputName": "Country-without-cn-private.mmdb", // 输出文件名为 Country-without-cn-private.mmdb
    "excludedList": ["cn", "private"]                // 不输出 cn、private 类别
  }
}
```

```jsonc
{
  "type": "ipinfoCountryMMDB",
  "action": "output",
  "args": {
    "outputName": "Country.mmdb",     // 输出文件名为 Country.mmdb
    "overwriteList": ["cn", "google"] // 确保 cn、google 类别最后写入，且 google 比 cn 后写入
  }
}
```

```jsonc
{
  "type": "ipinfoCountryMMDB",
  "action": "output",
  "args": {
    "outputName": "Country.mmdb",      // 输出文件名为 Country.mmdb
    "overwriteList": ["cn", "google"], // 确保 cn、google 类别最后写入，且 google 比 cn 后写入
    "onlyIPType": "ipv4"               // 只输出 cn、private 类别的 IPv4 地址
  }
}
```

```jsonc
{
  "type": "ipinfoCountryMMDB",
  "action": "output",
  "args": {
    "outputName": "Country.mmdb",                 // 输出文件名为 Country.mmdb
    "excludedList": ["private"],                  // 最终不输出 private 类别
    "wantedList": ["private" ,"au", "cloudflare"] // 只输出 au、cloudflare 类别，并确保 cloudflare 比 au 后写入。但由于 private 存在于 excludedList 中，最终不输出 private 类别
  }
}
```

```jsonc
{
  "type": "ipinfoCountryMMDB",
  "action": "output",
  "args": {
    "outputName": "Country.mmdb",                // 输出文件名为 Country.mmdb
    "excludedList": ["private"],                 // 最终不输出 private 类别
    "overwriteList": ["private" ,"cn", "google"] // 确保 cn、google 类别最后写入，且 google 比 cn 后写入。但由于 private 存在于 excludedList 中，最终不输出 private 类别
  }
}
```

```jsonc
{
  "type": "ipinfoCountryMMDB",
  "action": "output",
  "args": {
    "outputName": "Country.mmdb",                 // 输出文件名为 Country.mmdb
    "excludedList": ["private"],                  // 最终不输出 private 类别
    "overwriteList": ["private" ,"cn", "google"], // 确保 cn、google 类别最后写入，且 google 比 cn 后写入。但由于 private 存在于 excludedList 中，最终不输出 private 类别
    "sourceMMDBURI": "./ipinfo/country.mmdb"      // 用于补全生成的 MMDB 格式文件额外信息的 IPInfo 官方 country MMDB 格式文件。由于 private、google 类别不属于国家/地区类别，无法补全额外信息。
  }
}
```

### **lookup**

- **type**：（必须）输入格式的名称
- **action**：（必须）操作类型，值必须为 `output`
- **args**：（必须）
  - **search**：（必须）指定需要查询的 IP 或 CIDR
  - **searchList**：（可选，数组）从指定的类别中查询

```jsonc
{
  "type": "lookup",
  "action": "output",
  "args": {
    "search": "1.1.1.1" // 查询 IP 地址 1.1.1.1 所在的类别
  }
}
```

```jsonc
// 返回结果为单个类别名称，如：cn
// 或由英文逗号连接的类别字符串，如: au,cn
{
  "type": "lookup",
  "action": "output",
  "args": {
    "search": "1.1.1.0/24",          // 查询 CIDR 1.1.1.0/24 是否存在于类别 au、cn、us 中
    "searchList": ["au", "cn", "us"]
  }
}
```

### **maxmindMMDB**

- **type**：（必须）输入格式的名称
- **action**：（必须）操作类型，值必须为 `output`
- **args**：（可选）
  - **outputName**：（可选）输出的文件名
  - **outputDir**：（可选）输出目录
  - **onlyIPType**：（可选）输出的 IP 地址类型，值为 `ipv4` 或 `ipv6`
  - **wantedList**：（可选，数组）指定需要输出的类别
  - **excludedList**：（可选，数组）指定不需要输出的类别
  - **overwriteList**：（可选，数组）指定最后写入的类别（原因见👇）
  - **sourceMMDBURI**：（可选）指定用于补全本项目生成的 MMDB 格式文件所缺失的额外信息的 Maxmind 官方 country MMDB 格式文件路径，可为本地文件路径或远程 `http`、`https` 文件 URL（原因见👇）

> 由于 MaxMind mmdb 文件格式的限制，当不同列表的 IP 或 CIDR 数据有交集或重复项时，后写入的列表的 IP 或 CIDR 数据会覆盖（overwrite）之前已写入的列表的数据。譬如，IP `1.1.1.1` 同属于列表 `AU` 和列表 `Cloudflare`。如果 `Cloudflare` 在 `AU` 之后写入，则 IP `1.1.1.1` 最终归属于列表 `Cloudflare`。
>
> 为了确保某些指定的列表、被修改的列表一定囊括属于它的所有 IP 或 CIDR 数据，可在 output 输出格式为 `maxmindMMDB` 的配置中增加选项 `overwriteList`，该选项中指定的列表会在最后逐一写入，列表中最后一项优先级最高。若已设置选项 `wantedList`，则无需设置 `overwriteList`。`wantedList` 中指定的列表会在最后逐一写入，列表中最后一项优先级最高。
>
> `wantedList`、`overwriteList`、`excludedList` 三者中，`excludedList` 优先级最高。即：若设置了选项 `excludedList`，最终不会输出存在于 `excludedList` 中的列表。

> 由于本项目软件架构的限制，默认输出的 MMDB 格式文件只包含基本信息（`country.iso_code` 字段，即国家/地区两位英文字母代号），不包含其他额外信息（如 IP 或 CIDR 所属的国家/地区多语种名称、所属大洲及大洲多语种名称等）。为了跟官方提供的 MMDB 格式文件保持同样丰富的信息（字段），可通过配置选项 `sourceMMDBURI` 来指定 Maxmind 官方 country MMDB 格式文件路径，为本项目生成的 MMDB 格式文件补全缺失的额外信息。
>
> 只能补全国家/地区类别的额外信息。新增类别不属于国家/地区类别，不存在于 Maxmind 官方 country MMDB 格式文件中，无法补全。

```jsonc
// 默认输出目录 ./output/maxmind
{
  "type": "maxmindMMDB",
  "action": "output"
}
```

```jsonc
{
  "type": "maxmindMMDB",
  "action": "output",
  "args": {
    "outputDir": "./output",                      // 输出文件到 output 目录
    "outputName": "Country-only-cn-private.mmdb", // 输出文件名为 Country-only-cn-private.mmdb
    "wantedList": ["cn", "private"]               // 只输出 cn、private 类别
  }
}
```

```jsonc
{
  "type": "maxmindMMDB",
  "action": "output",
  "args": {
    "outputDir": "./output",                         // 输出文件到 output 目录
    "outputName": "Country-without-cn-private.mmdb", // 输出文件名为 Country-without-cn-private.mmdb
    "excludedList": ["cn", "private"]                // 不输出 cn、private 类别
  }
}
```

```jsonc
{
  "type": "maxmindMMDB",
  "action": "output",
  "args": {
    "outputName": "Country.mmdb",     // 输出文件名为 Country.mmdb
    "overwriteList": ["cn", "google"] // 确保 cn、google 类别最后写入，且 google 比 cn 后写入
  }
}
```

```jsonc
{
  "type": "maxmindMMDB",
  "action": "output",
  "args": {
    "outputName": "Country.mmdb",      // 输出文件名为 Country.mmdb
    "overwriteList": ["cn", "google"], // 确保 cn、google 类别最后写入，且 google 比 cn 后写入
    "onlyIPType": "ipv4"               // 只输出 cn、private 类别的 IPv4 地址
  }
}
```

```jsonc
{
  "type": "maxmindMMDB",
  "action": "output",
  "args": {
    "outputName": "Country.mmdb",                 // 输出文件名为 Country.mmdb
    "excludedList": ["private"],                  // 最终不输出 private 类别
    "wantedList": ["private" ,"au", "cloudflare"] // 只输出 au、cloudflare 类别，并确保 cloudflare 比 au 后写入。但由于 private 存在于 excludedList 中，最终不输出 private 类别
  }
}
```

```jsonc
{
  "type": "maxmindMMDB",
  "action": "output",
  "args": {
    "outputName": "Country.mmdb",                // 输出文件名为 Country.mmdb
    "excludedList": ["private"],                 // 最终不输出 private 类别
    "overwriteList": ["private" ,"cn", "google"] // 确保 cn、google 类别最后写入，且 google 比 cn 后写入。但由于 private 存在于 excludedList 中，最终不输出 private 类别
  }
}
```

```jsonc
{
  "type": "maxmindMMDB",
  "action": "output",
  "args": {
    "outputName": "Country.mmdb",                       // 输出文件名为 Country.mmdb
    "excludedList": ["private"],                        // 最终不输出 private 类别
    "overwriteList": ["private" ,"cn", "google"],       // 确保 cn、google 类别最后写入，且 google 比 cn 后写入。但由于 private 存在于 excludedList 中，最终不输出 private 类别
    "sourceMMDBURI": "./geolite2/GeoLite2-Country.mmdb" // 用于补全生成的 MMDB 格式文件额外信息的 Maxmind 官方 country MMDB 格式文件。由于 private、google 类别不属于国家/地区类别，无法补全额外信息。
  }
}
```

### **mihomoMRS**

- **type**：（必须）输入格式的名称
- **action**：（必须）操作类型，值必须为 `output`
- **args**：（可选）
  - **outputDir**：（可选）输出目录
  - **wantedList**：（可选，数组）指定需要输出的类别
  - **excludedList**：（可选，数组）指定不需要输出的类别
  - **onlyIPType**：（可选）输出的 IP 地址类型，值为 `ipv4` 或 `ipv6`

```jsonc
// 默认输出目录 ./output/mrs
{
  "type": "mihomoMRS",
  "action": "output"
}
```

```jsonc
{
  "type": "mihomoMRS",
  "action": "output",
  "args": {
    "outputDir": "./output",         // 输出文件到 output 目录
    "wantedList": ["cn", "private"]  // 只输出 cn、private 类别
  }
}
```

```jsonc
{
  "type": "mihomoMRS",
  "action": "output",
  "args": {
    "outputDir": "./output",           // 输出文件到 output 目录
    "excludedList": ["cn", "private"]  // 不输出 cn、private 类别
  }
}
```

```jsonc
{
  "type": "mihomoMRS",
  "action": "output",
  "args": {
    "onlyIPType": "ipv4" // 只输出 IPv4 地址
  }
}
```

### **singboxSRS**

- **type**：（必须）输入格式的名称
- **action**：（必须）操作类型，值必须为 `output`
- **args**：（可选）
  - **outputDir**：（可选）输出目录
  - **wantedList**：（可选，数组）指定需要输出的类别
  - **excludedList**：（可选，数组）指定不需要输出的类别
  - **onlyIPType**：（可选）输出的 IP 地址类型，值为 `ipv4` 或 `ipv6`

```jsonc
// 默认输出目录 ./output/srs
{
  "type": "singboxSRS",
  "action": "output"
}
```

```jsonc
{
  "type": "singboxSRS",
  "action": "output",
  "args": {
    "outputDir": "./output",        // 输出文件到 output 目录
    "wantedList": ["cn", "private"] // 只输出 cn、private 类别
  }
}
```

```jsonc
{
  "type": "singboxSRS",
  "action": "output",
  "args": {
    "outputDir": "./output",          // 输出文件到 output 目录
    "excludedList": ["cn", "private"] // 不输出 cn、private 类别
  }
}
```

```jsonc
{
  "type": "singboxSRS",
  "action": "output",
  "args": {
    "onlyIPType": "ipv4" // 只输出 IPv4 地址
  }
}
```

### **stdout**

- **type**：（必须）输入格式的名称
- **action**：（必须）操作类型，值必须为 `output`
- **args**：（可选）
  - **wantedList**：（可选，数组）指定需要输出的类别
  - **excludedList**：（可选，数组）指定不需要输出的类别
  - **onlyIPType**：（可选）输出的 IP 地址类型，值为 `ipv4` 或 `ipv6`

```jsonc
{
  "type": "stdout",
  "action": "output" // 输出所有类别到 standard output
}
```

```jsonc
{
  "type": "stdout",
  "action": "output",
  "args": {
    "wantedList": ["cn", "private"] // 只输出 cn、private 类别到 standard output
  }
}
```

```jsonc
{
  "type": "stdout",
  "action": "output",
  "args": {
    "excludedList": ["cn", "private"] // 不输出 cn、private 类别到 standard output
  }
}
```

```jsonc
{
  "type": "stdout",
  "action": "output",
  "args": {
    "onlyIPType": "ipv4" // 只输出 IPv4 地址到 standard output
  }
}
```

### **surgeRuleSet**

- **type**：（必须）输入格式的名称
- **action**：（必须）操作类型，值必须为 `output`
- **args**：（可选）
  - **outputDir**：（可选）输出目录
  - **outputExtension**：（可选）输出的文件的扩展名
  - **wantedList**：（可选，数组）指定需要输出的类别
  - **excludedList**：（可选，数组）指定不需要输出的类别
  - **onlyIPType**：（可选）输出的 IP 地址类型，值为 `ipv4` 或 `ipv6`

```jsonc
// 默认输出目录 ./output/surge
{
  "type": "surgeRuleSet",
  "action": "output"
}
```

```jsonc
{
  "type": "surgeRuleSet",
  "action": "output",
  "args": {
    "outputDir": "./surge",    // 输出文件到目录 ./surge
    "outputExtension": ".conf" // 输出文件的扩展名为 .conf
  }
}
```

```jsonc
{
  "type": "surgeRuleSet",
  "action": "output",
  "args": {
    "outputDir": "./surge",          // 输出文件到目录 ./surge
    "outputExtension": ".conf",      // 输出文件的扩展名为 .conf
    "wantedList": ["cn", "us", "jp"] // 只输出名为 cn、us、jp 这三个类别的 IPv4 和 IPv6 地址
  }
}
```

```jsonc
{
  "type": "surgeRuleSet",
  "action": "output",
  "args": {
    "outputDir": "./surge",            // 输出文件到目录 ./surge
    "outputExtension": ".conf",        // 输出文件的扩展名为 .conf
    "excludedList": ["cn", "us", "jp"] // 不输出名为 cn、us、jp 这三个类别的 IPv4 和 IPv6 地址
  }
}
```

```jsonc
{
  "type": "surgeRuleSet",
  "action": "output",
  "args": {
    "outputDir": "./surge",           // 输出文件到目录 ./surge
    "outputExtension": ".conf",       // 输出文件的扩展名为 .conf
    "wantedList": ["cn", "us", "jp"], // 只输出名为 cn、us、jp 这三个类别的 IPv4 地址
    "onlyIPType": "ipv4"
  }
}
```

### **text**

- **type**：（必须）输入格式的名称
- **action**：（必须）操作类型，值必须为 `output`
- **args**：（可选）
  - **outputDir**：（可选）输出目录
  - **outputExtension**：（可选）输出的文件的扩展名
  - **wantedList**：（可选，数组）指定需要输出的类别
  - **excludedList**：（可选，数组）指定不需要输出的类别
  - **onlyIPType**：（可选）输出的 IP 地址类型，值为 `ipv4` 或 `ipv6`
  - **addPrefixInLine**：（可选）给输出的每一行添加的字符串前缀
  - **addSuffixInLine**：（可选）给输出的每一行添加的字符串后缀

```jsonc
// 默认输出目录 ./output/text
{
  "type": "text",
  "action": "output",
  "args": {
    "outputDir": "./text",           // 输出文件到目录 ./text
    "outputExtension": ".conf",      // 输出文件的扩展名为 .conf
    "addPrefixInLine": "IP-CIDR,",
    "addSuffixInLine": ",no-resolve"
  }
}
```

```jsonc
{
  "type": "text",
  "action": "output",
  "args": {
    "outputDir": "./text",           // 输出文件到目录 ./text
    "outputExtension": ".conf",      // 输出文件的扩展名为 .conf
    "addPrefixInLine": "IP-CIDR,",
    "addSuffixInLine": ",no-resolve"
  }
}
```

```jsonc
{
  "type": "text",
  "action": "output",
  "args": {
    "outputDir": "./text",            // 输出文件到目录 ./text
    "outputExtension": ".conf",       // 输出文件的扩展名为 .conf
    "wantedList": ["cn", "us", "jp"], // 只输出名为 cn、us、jp 这三个类别的 IPv4 和 IPv6 地址
    "addPrefixInLine": "HOST,"
  }
}
```

```jsonc
{
  "type": "text",
  "action": "output",
  "args": {
    "outputDir": "./text",              // 输出文件到目录 ./text
    "outputExtension": ".conf",         // 输出文件的扩展名为 .conf
    "excludedList": ["cn", "us", "jp"], // 不输出名为 cn、us、jp 这三个类别的 IPv4 和 IPv6 地址
    "addPrefixInLine": "HOST,"
  }
}
```

```jsonc
{
  "type": "text",
  "action": "output",
  "args": {
    "outputDir": "./text",            // 输出文件到目录 ./text
    "outputExtension": ".conf",       // 输出文件的扩展名为 .conf
    "wantedList": ["cn", "us", "jp"], // 只输出名为 cn、us、jp 这三个类别的 IPv4 地址
    "onlyIPType": "ipv4",
    "addSuffixInLine": ";"
  }
}
```

### **v2rayGeoIPDat**

- **type**：（必须）输入格式的名称
- **action**：（必须）操作类型，值必须为 `output`
- **args**：（可选）
  - **outputName**：（可选）输出的文件名
  - **outputDir**：（可选）输出目录
  - **wantedList**：（可选，数组）指定需要输出的类别
  - **excludedList**：（可选，数组）指定不需要输出的类别
  - **onlyIPType**：（可选）输出的 IP 地址类型，值为 `ipv4` 或 `ipv6`
  - **oneFilePerList**：（可选）每个类别输出为一个单独的文件，值为 `true` 或 `false`（默认值）

```jsonc
// 默认输出目录 ./output/dat
{
  "type": "v2rayGeoIPDat",
  "action": "output"      // 输出全部类别
}
```

```jsonc
{
  "type": "v2rayGeoIPDat",
  "action": "output",
  "args": {
    "oneFilePerList": true // 每个类别输出为一个单独的文件
  }
}
```

```jsonc
{
  "type": "v2rayGeoIPDat",
  "action": "output",
  "args": {
    "outputDir": "./output",                   // 输出文件到 output 目录
    "outputName": "geoip-only-cn-private.dat", // 输出文件名为 geoip-only-cn-private.dat
    "wantedList": ["cn", "private"]            // 只输出 cn、private 类别
  }
}
```

```jsonc
{
  "type": "v2rayGeoIPDat",
  "action": "output",
  "args": {
    "outputDir": "./output",                      // 输出文件到 output 目录
    "outputName": "geoip-without-cn-private.dat", // 输出文件名为 geoip-without-cn-private.dat
    "excludedList": ["cn", "private"]             // 不输出 cn、private 类别
  }
}
```

```jsonc
{
  "type": "v2rayGeoIPDat",
  "action": "output",
  "args": {
    "outputName": "geoip-asn.dat",        // 输出文件名为 geoip-asn.dat
    "wantedList": ["telegram", "google"], // 只输出 telegram、google
    "onlyIPType": "ipv4"                  // 只输出 telegram、google 类别的 IPv4 地址
  }
}
```

```jsonc
{
  "type": "v2rayGeoIPDat",
  "action": "output",
  "args": {
    "wantedList": ["telegram", "google"], // 只输出 telegram、google
    "onlyIPType": "ipv4",                 // 只输出 telegram、google 类别的 IPv4 地址
    "oneFilePerList": true                // 每个类别输出为一个单独的文件
  }
}
```