/AdGuardCLI

AdGuard Ad Blocker command-line version

AdGuard CLI

Tool to protect against ads, trackers and malicious websites

Designed for command-line users

Website | Reddit | Twitter | Telegram

Latest release Beta version Nightly version

Disclaimer

Overview

AdGuard CLI is the command-line version of AdGuard Ad Blocker. Learn more about it in our Knowledge base.

Installation

To install the latest version of AdGuard CLI, run the following command:

Release channel:

curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardCLI/release/install.sh | sh -s -- -v

Beta channel:

curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardCLI/beta/install.sh | sh -s -- -v

Nightly channel:

curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardCLI/nightly/install.sh | sh -s -- -v

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 gpg tool installed.

First, import the AdGuard public key:

gpg --keyserver 'keys.openpgp.org' --recv-key '28645AC9776EC4C00BCE2AFC0FE641E7235E2EC6'

Then, verify the signature:

gpg --verify /opt/adguard_cli/adguard-cli.sig

If you use a custom installation path, replace /opt/adguard_cli/adguard-cli.sig with the path to the signature file. It should be in the same directory as the binary file.

You’ll see something like this:

gpg: assuming signed data in 'adguard-cli'
gpg: Signature made Fri Nov 15 13:20:43 2024 +02
gpg:                using RSA key 28645AC9776EC4C00BCE2AFC0FE641E7235E2EC6
gpg:                issuer "devteam@adguard.com"
gpg: Good signature from "AdGuard <devteam@adguard.com>" [ultimate]

Check the following:

  • RSA key: must be 28645AC9776EC4C00BCE2AFC0FE641E7235E2EC6;
  • Issuer name: must be AdGuard;
  • Email address: must be devteam@adguard.com.

There may also be the following warning:

gpg: WARNING: The key's User ID is not certified with a trusted signature!
gpg:          There is no indication that the signature belongs to the owner.
Primary key fingerprint: 2864 5AC9 776E C4C0 0BCE  2AFC 0FE6 41E7 235E 2EC6

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 an AdGuard license
  • reset-license Reset an AdGuard license
  • configure Run the configuration wizard
  • start Start AdGuard CLI
  • 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
    • 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
  • check-update Check for updates
  • update Update AdGuard CLI
    • -v, --verbose Show update script output
  • filters Manage filters
    • list List installed and added filters, or all available filters if --all is specified
    • add Add internal filter, by ID or name
    • install Install a custom filter
    • remove Remove internal or custom filter
    • enable Enable the filter (Rules from this filter will be applied)
    • disable Disable the filter (Rules from this filter will no longer be applied)
    • update Update filters
  • 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