AdGuardVPNCLI

AdGuardVPNCLI copied to clipboard

Fast, flexible and reliable VPN solution for command-line enthusiasts

Your online safety and anonymity guaranteed by a trusted developer.

Website | Reddit | Twitter | Telegram

Disclaimer

• AdGuard VPN 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.
• Privacy policy: https://adguard-vpn.com/privacy.html

Overview

AdGuard VPN CLI provides a command-line interface for managing VPN connection.

Installation

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

Just replace <update_channel> with one of the following values: release, beta, nightly

curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardVPNCLI/master/scripts/<update_channel>/install.sh | sh -s -- -v

To install a specific version of AdGuard VPN CLI, run the following command:

sh -c "$(curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardVPNCLI/master/scripts/<update_channel>/install.sh)" install.sh -v -V <version_number>

Verify Releases

Inside an archive file there's a small file with .sig extension which contains the signature data. In a hypothetic situation when the binary file inside an archive is replaced by someone, you'll know that 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/adguardvpn_cli/adguardvpn-cli.sig 

If you use custom installation path, replace /opt/adguardvpn_cli/adguardvpn-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 'adguardvpn-cli'
gpg: Signature made Wed Feb 28 19:24:43 2024 +08
gpg:                using RSA key 28645AC9776EC4C00BCE2AFC0FE641E7235E2EC6
gpg:                issuer "[email protected]"
gpg: Good signature from "AdGuard <[email protected]>" [ultimate]

Check the following:

• RSA key: must be 28645AC9776EC4C00BCE2AFC0FE641E7235E2EC6;
• issuer name: must be AdGuard;
• E-mail address: must be [email protected];

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 adguardvpn-cli [command] to use the VPN service. Below are the available commands and their options:

General Options

• -h, --help: Print the help message and exit.
• --help-all: Expand all help.
• -v, --version: Display program version information and exit.

Subcommands

Each subcommand has its own set of options. Run adguardvpn-cli [command] --help to see the list of available options.

login

Log in to the VPN service.

• -u, --username TEXT: Username for login.
• -p, --password TEXT: Password for login.

logout

Log out from the VPN service.

list-locations

List all available VPN locations.

• count INT: Number of locations to display, sorted by ping.

connect

Connect to the VPN service.

• -l, --location TEXT: Specify the location to connect to. Defaults to the last used location.
• -f, --fastest: Connect to the fastest available location.
• -v, --verbose: Show log from the VPN service.
• --no-fork: Do not fork the VPN service to the background.

disconnect

Stop the VPN service.

status

Display the current status of the VPN service.

config

Configure the VPN service with the following subcommands:

• set-mode: Set the tool to operate in VPN mode (default SOCKS address: 127.0.0.1:1080)
• set-dns: Set the DNS upstream server
• set-socks-port: Set the SOCKS port
• set-system-dns: Set the system DNS servers by CLI VPN App. Available values: on, off
• set-no-routes: Set the no routes flag. Available values: on, off. If enabled, the VPN service will not add any routes to the system routing table.
• send-reports: Send crash reports to developers. Available values: on, off
• set-updates-channel: Set the updates channel. Available channels: stable, beta, nightly
• show: Show the current configuration

check-update

Check for updates to the VPN service.

update

Update VPN CLI to the latest version from the specified channel.