https://github.com/adguardteam/adguardcli
AdGuard Ad Blocker command-line version
https://github.com/adguardteam/adguardcli
adblock adguard cli linux
Last synced: about 1 month ago
JSON representation
AdGuard Ad Blocker command-line version
- Host: GitHub
- URL: https://github.com/adguardteam/adguardcli
- Owner: AdguardTeam
- Created: 2024-10-01T22:03:03.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2026-02-17T14:38:07.000Z (about 1 month ago)
- Last Synced: 2026-02-17T19:36:43.697Z (about 1 month ago)
- Topics: adblock, adguard, cli, linux
- Homepage: https://adguard.com/
- Size: 48.8 KB
- Stars: 127
- Watchers: 15
- Forks: 4
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Tool to protect against ads, trackers and malicious websites
Designed for command-line users
Website |
Reddit |
Twitter |
Telegram
> ### Disclaimer
>* AdGuard CLI is not an open source project. We use GitHub as an open bug tracker for users to see what developers are working on. However, we at AdGuard create [a lot of open source software](https://github.com/search?o=desc&q=topic%3Aopen-source+org%3AAdguardTeam+fork%3Atrue&s=stars&type=Repositories).
> * Privacy policy: https://adguard.com/privacy.html
## Overview
AdGuard CLI is the command-line version of AdGuard Ad Blocker. Learn more about it [in our Knowledge base](https://adguard.com/kb/adguard-for-linux/).
## Installation
To install the latest version of AdGuard CLI, run the following command:
Release channel:
```shell
curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardCLI/release/install.sh | sh -s -- -v
```
Beta channel:
```shell
curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardCLI/beta/install.sh | sh -s -- -v
```
Nightly channel:
```shell
curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardCLI/nightly/install.sh | sh -s -- -v
```
Please see [our Knowledge base](https://adguard.com/kb/adguard-for-linux/installation/) for more info about installation/deinstallation.
## Verify Releases
Inside an archive file, there is a small file with a `.sig` extension that contains the signature data. In a hypothetical situation where the binary file inside an archive is replaced by someone, you’ll know it isn’t an official release from AdGuard.
To verify the signature, you need to have the `openssl` tool version 1.1.1 or newer installed.
First, import the AdGuard public key:
```shell
curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardCLI/master/adguard_ed25519_pubkey.pem -o adguard_ed25519_pubkey.pem
```
It will download public key, which should have the value `MCowBQYDK2VwAyEAN0NPZFtolGN+Cjyorh4Wo91vnBlLLQiWkbujeHDYbok=`.
Then, verify the signature:
```shell
openssl pkeyutl -verify -inkey adguard_ed25519_pubkey.pem -pubin -sigfile /opt/adguard-cli/adguard-cli.sig -in /opt/adguard-cli/adguard-cli -rawin
```
If you use a custom installation path, replace `/opt/adguard-cli` with the path to the adguard-cli and its signature file.
You’ll see the following message:
```
Signature Verified Successfully
```
## Usage
Run `adguard-cli [command]` to use AdGuard CLI. Below are the available commands and their options:
### Options
- `-h, --help` Print this help message and exit
- `--help-all` Show all available commands, subcommands, and options
- `-v, --version` Display program version information and exit
### Subcommands
- `activate` Activate the app
- `reset-license` Deactivate the app
- `configure` Run the configuration wizard
- `start` Start AdGuard CLI
- `restart` Restart AdGuard CLI if it is already running
- `stop` Stop AdGuard CLI
- `status` Show the status of AdGuard CLI
- `license` Show license information
- `config` Configure AdGuard CLI
- `show` Show current configuration from `proxy.yaml`
- `--list-file` Path to a YAML file to show instead of the configuration, e.g. `browsers.yaml`
- `set` Set a single option in `proxy.yaml`, e.g.:
- `listen_ports.http_proxy` sets the HTTP listen port
- `proxy_mode` sets the proxy mode (manual or auto)
- `get` Get a single option from `proxy.yaml`
- `list-add` Add a value to a list with the specified key in proxy.yaml, e.g.:
- `filters` adds a file with filters
- `apps` a filter action for an application; specify the application name and the action (default, bypass_https, bypass) separated by a space, and optionally allow skip outbound proxy by writing it as the third value
- `--list-file` Path to the YAML file where the application will be added (e.g. `browsers.yaml`)
- `list-remove` Remove a value from a list with the specified key in `proxy.yaml`, e.g.:
- `filters` removes a filter file
- `apps` removes an application rule by name
- `--list-file` Path to the YAML file from which the application will be removed (e.g. `browsers.yaml`)
- `reset` Reset to default a value of a setting with the specified key in `proxy.yaml`, e.g.
- `listen_ports.http_proxy` resets the HTTP listening port to the default value (3129)
- `proxy_mode` resets the proxy mode to the default value (manual)
- `--all` Reset all settings to their default values
- `check-update` Check for updates
- `update` Update AdGuard CLI
- `-v, --verbose` Show update script output
- `filters` Manage filters
- `list` List installed filters
- `--all` Show all filters
- `install` Install a filter
- `enable` Enable a filter
- `disable` Disable a filter
- `update` Update filters
- `add` Add a filter by its ID or name
- `remove` Remove a filter by its ID or name
- `export-logs` Export logs to a zip file
- `-o, --output TEXT` Path to the output artifact. Can be a directory
- `-f, --force` Overwrite the output artifact without asking
### Per-app AdGuard CLI configuration
AdGuard CLI behaviour can be configured per-app. See the `apps` section of `proxy.yaml` for details.
There's a number of pre-configured entries for popular web browsers,
contained in `browsers.yaml` and included by default.
## AdGuard VPN CLI interaction
Using AdGuard CLI in **automatic proxy mode** together with AdGuard VPN CLI in **tunnel mode** is impossible due to a
routing loop: AdGuard VPN CLI's traffic currently can not be excluded from being transparently proxied by AdGuard CLI,
and AdGuard CLI's traffic must go through the AdGuard VPN CLI's tunnel.
These are the two possible solutions:
1. Switch AdGuard CLI to **manual proxy mode**.
- In this case, AdGuard VPN CLI can be used in **tunnel mode**, but apps for which ad blocking is desired must be
manually configured to use the AdGuard CLI's proxy.
2. Switch AdGuard VPN CLI to **SOCKS5 mode**, and configure AdGuard CLI with an outbound proxy pointing to the SOCKS5
interface of AdGuard VPN CLI.
- Note that in this case for an app's traffic to go through the VPN tunnel it must either have its traffic
transparently proxied by AdGuard CLI (which is the case for all apps by default), or manually configured to use
AdGuard VPN CLI's SOCKS5 interface.
- Also note that in this case, in order to avoid a routing loop, the `skip_outbound_proxy` option must be enabled
for AdGuard VPN CLI in AdGuard CLI's apps configuration section. By default, `skip_outbound_proxy` is enabled for
all apps with `vpn` in their name, which includes AdGuard VPN CLI.