### Install AdGuard VPN CLI (Beta Channel) Source: https://github.com/adguardteam/adguardvpncli/blob/master/README.md Use this command to install the beta version of AdGuard VPN CLI for testing. ```shell curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardVPNCLI/HEAD/scripts/beta/install.sh | sh -s -- -v ``` -------------------------------- ### Install AdGuard VPN CLI (Release Channel) Source: https://github.com/adguardteam/adguardvpncli/blob/master/README.md Use this command to install the latest stable release of AdGuard VPN CLI. ```shell curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardVPNCLI/HEAD/scripts/release/install.sh | sh -s -- -v ``` -------------------------------- ### Install AdGuard VPN CLI Source: https://context7.com/adguardteam/adguardvpncli/llms.txt Installs the AdGuard VPN CLI using a script. Options include specifying a version, custom output directory, automatic confirmation, or uninstallation. ```bash curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardVPNCLI/HEAD/scripts/release/install.sh | sh -s -- -v ``` ```bash curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardVPNCLI/HEAD/scripts/release/install.sh | sh -s -- -v -o /custom/path ``` ```bash curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardVPNCLI/HEAD/scripts/release/install.sh | sh -s -- -v -a y ``` ```bash curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardVPNCLI/HEAD/scripts/release/install.sh | sh -s -- -u ``` -------------------------------- ### Install AdGuard VPN CLI (Nightly Channel) Source: https://github.com/adguardteam/adguardvpncli/blob/master/README.md Use this command to install the nightly build of AdGuard VPN CLI for the latest development features. ```shell curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardVPNCLI/HEAD/scripts/nightly/install.sh | sh -s -- -v ``` -------------------------------- ### Example GPG Verification Output Source: https://github.com/adguardteam/adguardvpncli/blob/master/README.md This is an example of a successful GPG signature verification output. Check the RSA key, issuer name, and email address for authenticity. ```text 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 "devteam@adguard.com" gpg: Good signature from "AdGuard " [ultimate] ``` -------------------------------- ### Import AdGuard Public GPG Key Source: https://github.com/adguardteam/adguardvpncli/blob/master/README.md Import the AdGuard public GPG key to verify release signatures. Ensure you have the 'gpg' tool installed. ```shell gpg --keyserver 'keys.openpgp.org' --recv-key '28645AC9776EC4C00BCE2AFC0FE641E7235E2EC6' ``` -------------------------------- ### Check and Install AdGuard VPN CLI Updates Source: https://context7.com/adguardteam/adguardvpncli/llms.txt Manage updates for the AdGuard VPN CLI. 'check-update' verifies if an update is available. 'update' installs the latest version. Use '--verbose' for detailed output or '--yes' to automatically confirm prompts. ```bash adguardvpn-cli check-update ``` ```bash adguardvpn-cli update ``` ```bash adguardvpn-cli update --verbose ``` ```bash adguardvpn-cli update --yes ``` -------------------------------- ### Update VPN Service Source: https://github.com/adguardteam/adguardvpncli/blob/master/README.md Installs the latest available version of the VPN service. ```APIDOC ## Update VPN Service ### Endpoint `adguardvpn-cli update` ### Description Install the latest version if available. ### Parameters #### Query Parameters - `-v, --verbose` - Show update script output. - `-y, --yes` - Automatically answer 'yes' to all questions. ``` -------------------------------- ### Example GPG Warning Message Source: https://github.com/adguardteam/adguardvpncli/blob/master/README.md This is an example of a potential warning message during GPG verification. It indicates that the User ID is not certified with a trusted signature. ```text 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 ``` -------------------------------- ### Update AdGuard VPN service Source: https://github.com/adguardteam/adguardvpncli/blob/master/README.md Installs the latest available version of the AdGuard VPN service. Use flags to show output or automatically confirm. ```bash adguardvpn-cli update -v, --verbose ``` ```bash adguardvpn-cli update -y, --yes ``` -------------------------------- ### Check for AdGuard VPN updates Source: https://github.com/adguardteam/adguardvpncli/blob/master/README.md Checks if a new version of the AdGuard VPN service is available and prompts for installation. ```bash adguardvpn-cli check-update ``` -------------------------------- ### Verify AdGuard VPN CLI Signature Source: https://github.com/adguardteam/adguardvpncli/blob/master/README.md Verify the signature of the AdGuard VPN CLI binary using its corresponding .sig file. Replace the path if you used a custom installation directory. ```shell gpg --verify /opt/adguardvpn_cli/adguardvpn-cli.sig ``` -------------------------------- ### Access AdGuard VPN CLI Help and Version Information Source: https://context7.com/adguardteam/adguardvpncli/llms.txt Retrieve help documentation and version details for the AdGuard VPN CLI. Use '--help' for general help, '--help-all' for comprehensive command details, and '--version' for the application version. Specific subcommands also have their own help flags. ```bash adguardvpn-cli --help ``` ```bash adguardvpn-cli --help-all ``` ```bash adguardvpn-cli --version ``` ```bash adguardvpn-cli connect --help ``` ```bash adguardvpn-cli config --help ``` ```bash adguardvpn-cli site-exclusions --help ``` -------------------------------- ### Connect to AdGuard VPN Source: https://context7.com/adguardteam/adguardvpncli/llms.txt Establishes a VPN connection. Options include connecting to the fastest server, a specific location by name or country code, enabling verbose output, or forcing IPv4/IPv6. ```bash adguardvpn-cli connect --fastest ``` ```bash adguardvpn-cli connect --location "New York" ``` ```bash adguardvpn-cli connect --location US ``` ```bash adguardvpn-cli connect --fastest --verbose ``` ```bash adguardvpn-cli connect --location DE --no-fork ``` ```bash adguardvpn-cli connect --fastest --yes ``` ```bash adguardvpn-cli connect --fastest --ipv4only ``` ```bash adguardvpn-cli connect --fastest --ipv6only ``` -------------------------------- ### Connect to AdGuard VPN Source: https://github.com/adguardteam/adguardvpncli/blob/master/README.md Connects to the AdGuard VPN service. You can specify a location, connect to the fastest server, or enable verbose logging. Use `--no-fork` to keep the service in the foreground. ```bash adguardvpn-cli connect -l, --location TEXT ``` ```bash adguardvpn-cli connect -f, --fastest ``` ```bash adguardvpn-cli connect -v, --verbose ``` ```bash adguardvpn-cli connect --no-fork ``` ```bash adguardvpn-cli connect -y, --yes ``` ```bash adguardvpn-cli connect -4, --ipv4only ``` ```bash adguardvpn-cli connect -6, --ipv6only ``` -------------------------------- ### Log in to AdGuard VPN CLI Source: https://github.com/adguardteam/adguardvpncli/blob/master/README.md Use this command to log in to your AdGuard account or create a new one. You will be prompted to open a link in your browser for authentication. ```bash adguardvpn-cli login ``` -------------------------------- ### AdGuard VPN CLI Configuration Management Source: https://context7.com/adguardteam/adguardvpncli/llms.txt Manages various VPN settings including operating mode, DNS servers, SOCKS proxy, protocol, and routing. Use 'show' to view current settings. ```bash adguardvpn-cli config show ``` ```bash adguardvpn-cli config set-mode TUN ``` ```bash adguardvpn-cli config set-mode SOCKS ``` ```bash adguardvpn-cli config set-dns 8.8.8.8 ``` ```bash adguardvpn-cli config set-socks-port 1080 ``` ```bash adguardvpn-cli config set-socks-host 127.0.0.1 ``` ```bash adguardvpn-cli config set-socks-username myuser ``` ```bash adguardvpn-cli config set-socks-password mypassword ``` ```bash adguardvpn-cli config clear-socks-auth ``` ```bash adguardvpn-cli config set-tun-routing-mode AUTO ``` ```bash adguardvpn-cli config set-tun-routing-mode SCRIPT ``` ```bash adguardvpn-cli config set-tun-routing-mode NONE ``` ```bash adguardvpn-cli config create-route-script ``` ```bash adguardvpn-cli config set-protocol auto ``` ```bash adguardvpn-cli config set-protocol http2 ``` ```bash adguardvpn-cli config set-protocol quic ``` ```bash adguardvpn-cli config set-post-quantum true ``` ```bash adguardvpn-cli config set-change-system-dns true ``` ```bash adguardvpn-cli config set-debug-logging true ``` ```bash adguardvpn-cli config set-crash-reporting true ``` -------------------------------- ### Configure AdGuard VPN CLI Hints and Notifications Source: https://context7.com/adguardteam/adguardvpncli/llms.txt Control the display of hints and notifications within the AdGuard VPN CLI. Set 'set-show-hints' to true or false to enable or disable hints, and 'set-show-notifications' to true or false for notifications. ```bash adguardvpn-cli config set-show-hints true ``` ```bash adguardvpn-cli config set-show-notifications true ``` -------------------------------- ### Verify AdGuard VPN CLI Release Signatures with GPG Source: https://context7.com/adguardteam/adguardvpncli/llms.txt Ensure the integrity of AdGuard VPN CLI binaries by verifying their GPG signatures. This process involves importing the AdGuard public key and then using GPG to verify the signature file against the binary. ```bash gpg --keyserver 'keys.openpgp.org' --recv-key '28645AC9776EC4C00BCE2AFC0FE641E7235E2EC6' ``` ```bash gpg --verify /opt/adguardvpn_cli/adguardvpn-cli.sig ``` ```bash gpg --verify /custom/path/adguardvpn-cli.sig ``` -------------------------------- ### Connect to VPN Source: https://github.com/adguardteam/adguardvpncli/blob/master/README.md Connects to the AdGuard VPN service. ```APIDOC ## Connect to VPN ### Endpoint `adguardvpn-cli connect` ### Description Connect to the VPN service. ### Parameters #### Query Parameters - `-l, --location` (TEXT) - Specify the location to connect to (city name, country name, or ISO code). 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. - `-y, --yes` - Automatically answer 'yes' to all questions. - `-4, --ipv4only` - Force the application to connect only to IPv4 servers. - `-6, --ipv6only` - Force the application to connect only to IPv6 servers. ``` -------------------------------- ### Manage Site Exclusions in AdGuard VPN CLI Source: https://context7.com/adguardteam/adguardvpncli/llms.txt Control which websites bypass or use the VPN tunnel. Use 'show' to view current exclusions, 'add' to include new sites (wildcards supported), 'remove' to delete them, and 'clear' to remove all. ```bash adguardvpn-cli site-exclusions show ``` ```bash adguardvpn-cli site-exclusions add example.com ``` ```bash adguardvpn-cli site-exclusions add "*.google.com" ``` ```bash adguardvpn-cli site-exclusions remove example.com ``` ```bash adguardvpn-cli site-exclusions clear ``` -------------------------------- ### List available VPN locations Source: https://github.com/adguardteam/adguardvpncli/blob/master/README.md Displays a list of all available VPN server locations, sorted by ping time. You can specify the number of locations to display. ```bash adguardvpn-cli list-locations ``` ```bash adguardvpn-cli list-locations --bash-completion TEXT ``` -------------------------------- ### User Authentication Source: https://github.com/adguardteam/adguardvpncli/blob/master/README.md Instructions for logging in and logging out of the AdGuard VPN service using the CLI. ```APIDOC ## User Authentication ### Log in To log in or create an account, type: adguardvpn-cli login When prompted with the menu, select `b` to open the authentication page in your default browser. Enter your email address. Once you are logged in, you will see the message *Successfully logged in* in the Terminal. You can set up your preferred login method (password or one-time code) and two-factor authentication in your [AdGuard account](https://adguardaccount.com/account/settings). **Note:** You can also create an AdGuard account on our [website](https://auth.adguardaccount.com/login.html) and then log in to AdGuard VPN for Linux using your credentials. ### Log out To log out of AdGuard VPN, type: adguardvpn-cli logout ``` -------------------------------- ### Configure AdGuard VPN service Source: https://github.com/adguardteam/adguardvpncli/blob/master/README.md Provides subcommands to configure various aspects of the AdGuard VPN service, including mode, DNS, SOCKS settings, routing, crash reporting, update channels, protocols, and more. ```bash adguardvpn-cli config set-mode ``` ```bash adguardvpn-cli config set-dns ``` ```bash adguardvpn-cli config set-socks-port ``` ```bash adguardvpn-cli config set-socks-host ``` ```bash adguardvpn-cli config set-socks-username ``` ```bash adguardvpn-cli config set-socks-password ``` ```bash adguardvpn-cli config clear-socks-auth ``` ```bash adguardvpn-cli config set-change-system-dns ``` ```bash adguardvpn-cli config set-tun-routing-mode ``` ```bash adguardvpn-cli config create-route-script ``` ```bash adguardvpn-cli config set-crash-reporting ``` ```bash adguardvpn-cli config set-update-channel ``` ```bash adguardvpn-cli config set-protocol ``` ```bash adguardvpn-cli config set-post-quantum ``` ```bash adguardvpn-cli config set-show-hints ``` ```bash adguardvpn-cli config set-debug-logging ``` ```bash adguardvpn-cli config set-show-notifications ``` ```bash adguardvpn-cli config set-bound-if-override ``` ```bash adguardvpn-cli config show ``` -------------------------------- ### Set AdGuard VPN CLI Exclusion Mode Source: https://context7.com/adguardteam/adguardvpncli/llms.txt Configure the site exclusion mode. 'general' mode applies exclusions globally, while 'selective' mode requires explicit rules for each site. Use 'mode' to set or view the current mode. ```bash adguardvpn-cli site-exclusions mode general ``` ```bash adguardvpn-cli site-exclusions mode selective ``` ```bash adguardvpn-cli site-exclusions mode ``` -------------------------------- ### License Information Source: https://github.com/adguardteam/adguardvpncli/blob/master/README.md Retrieves license information for AdGuard VPN. ```APIDOC ## License Information ### Endpoint `adguardvpn-cli license` ### Description Get license information. ``` -------------------------------- ### List Available VPN Locations Source: https://context7.com/adguardteam/adguardvpncli/llms.txt Retrieves a list of all available VPN server locations. Can optionally sort by ping latency to display the top locations. ```bash adguardvpn-cli list-locations ``` ```bash adguardvpn-cli list-locations --count 10 ``` -------------------------------- ### Export AdGuard VPN CLI Diagnostic Logs Source: https://context7.com/adguardteam/adguardvpncli/llms.txt Generate and export diagnostic logs for troubleshooting. By default, logs are saved to the default location. Use '--output' to specify a directory or filename, and '--force' to overwrite existing files. ```bash adguardvpn-cli export-logs ``` ```bash adguardvpn-cli export-logs --output /path/to/logs/ ``` ```bash adguardvpn-cli export-logs --output /path/to/vpn-logs.zip --force ``` -------------------------------- ### Configuration Management Source: https://github.com/adguardteam/adguardvpncli/blob/master/README.md Manages various configuration settings for the AdGuard VPN service. ```APIDOC ## Configuration Management ### Endpoint `adguardvpn-cli config [subcommand]` ### Description Configure the VPN service with various subcommands. ### Subcommands: - `set-mode`: Set VPN operating mode (TUN/SOCKS). SOCKS default address is `127.0.0.1:1080`. You can adjust the port number. - `set-dns`: Set the DNS upstream server. - `set-socks-port`: Set the SOCKS port. - `set-socks-host`: Set the SOCKS listen host. For non-localhost addresses, you need to protect the proxy with a username and password. - `set-socks-username`: Set the SOCKS username. - `set-socks-password`: Set the SOCKS password. - `clear-socks-auth`: Clear the SOCKS username and password. - `set-change-system-dns`: Set the system DNS servers. - `set-tun-routing-mode`: Set VPN tunnel routing mode (AUTO/SCRIPT/NONE). - `create-route-script`: Create a route script with proper permissions. - `set-crash-reporting`: Send crash reports to developers. - `set-update-channel`: Set the update channel (release, beta, nightly). - `set-protocol`: Set the protocol used by AdGuard VPN. Available values: `auto`, `http2`, `quic`. - `set-post-quantum`: Set the use of advanced cryptographic algorithms resistant to quantum computer attacks to protect your traffic from potential future threats. - `set-show-hints`: Show hints after command execution. - `set-debug-logging`: Enable or disable debug logging. - `set-show-notifications`: Show notifications about the VPN connection status. - `set-bound-if-override`: Override network interface to use for outbound VPN traffic (pass "" to disable). - `show`: Show the current configuration. ``` -------------------------------- ### AdGuard VPN CLI Login and Logout Source: https://context7.com/adguardteam/adguardvpncli/llms.txt Authenticates with your AdGuard account to enable VPN functionality. The login process may open a browser for authentication. Use 's' to speed up the check and 'x' to cancel. ```bash adguardvpn-cli login ``` ```bash adguardvpn-cli logout ``` -------------------------------- ### Export AdGuard VPN logs Source: https://github.com/adguardteam/adguardvpncli/blob/master/README.md Exports the current AdGuard VPN logs to a zip file. You can specify the output path and force overwriting. ```bash adguardvpn-cli export-logs -o, --output TEXT ``` ```bash adguardvpn-cli export-logs -f, --force ``` -------------------------------- ### Display AdGuard VPN License Information Source: https://context7.com/adguardteam/adguardvpncli/llms.txt Retrieves information about your current AdGuard VPN license and subscription status. ```bash adguardvpn-cli license ``` -------------------------------- ### List Locations Source: https://github.com/adguardteam/adguardvpncli/blob/master/README.md Lists all available VPN locations, sorted by ping. ```APIDOC ## List Locations ### Endpoint `adguardvpn-cli list-locations` ### Description List all available VPN locations. ### Parameters #### Query Parameters - `count` (INT) - Number of locations to display, sorted by ping. - `--bash-completion` (TEXT) - List suggestions for bash-completion. ``` -------------------------------- ### Manage AdGuard VPN site exclusions Source: https://github.com/adguardteam/adguardvpncli/blob/master/README.md Controls site exclusions for the VPN. Allows adding, removing, showing, clearing, and setting the exclusion mode (general/selective). ```bash adguardvpn-cli site-exclusions add ``` ```bash adguardvpn-cli site-exclusions remove ``` ```bash adguardvpn-cli site-exclusions show ``` ```bash adguardvpn-cli site-exclusions clear ``` ```bash adguardvpn-cli site-exclusions mode ``` -------------------------------- ### Export Logs Source: https://github.com/adguardteam/adguardvpncli/blob/master/README.md Exports logs from the VPN service to a zip file. ```APIDOC ## Export Logs ### Endpoint `adguardvpn-cli export-logs` ### Description Export logs to a zip file. ### Parameters #### Query Parameters - `-o, --output` (TEXT) - Path to the output artifact. Can be a directory. - `-f, --force` - Overwrite the output artifact without asking. ``` -------------------------------- ### Configure AdGuard VPN CLI Update Channel Source: https://context7.com/adguardteam/adguardvpncli/llms.txt Set the update channel for the AdGuard VPN CLI application. Use 'release' for stable versions, 'beta' for pre-release versions, or 'nightly' for the latest development builds. ```bash adguardvpn-cli config set-update-channel release ``` ```bash adguardvpn-cli config set-update-channel beta ``` ```bash adguardvpn-cli config set-update-channel nightly ``` -------------------------------- ### Check for Updates Source: https://github.com/adguardteam/adguardvpncli/blob/master/README.md Checks if a new version of the VPN service is available. ```APIDOC ## Check for Updates ### Endpoint `adguardvpn-cli check-update` ### Description Check for updates to the VPN service. ``` -------------------------------- ### Site Exclusions Management Source: https://github.com/adguardteam/adguardvpncli/blob/master/README.md Manages site exclusions for the VPN service. ```APIDOC ## Site Exclusions Management ### Endpoint `adguardvpn-cli site-exclusions [subcommand]` ### Description Control site exclusions with the following subcommands. ### Subcommands: - `add`: Add specified exclusions. - `remove`: Remove specified exclusions. - `show`: Show all exclusions. - `clear`: Clear all exclusions. - `mode`: Set VPN exclusion mode (general/selective) or show the current mode if no options are passed. ``` -------------------------------- ### Check AdGuard VPN Status Source: https://context7.com/adguardteam/adguardvpncli/llms.txt Displays the current status of the VPN service, including connection state and active location. ```bash adguardvpn-cli status ``` -------------------------------- ### Override Network Interface for AdGuard VPN CLI Source: https://context7.com/adguardteam/adguardvpncli/llms.txt Specify a network interface for outbound VPN traffic. Use 'set-bound-if-override' followed by the interface name (e.g., 'eth0'). To disable the override, use an empty string. ```bash adguardvpn-cli config set-bound-if-override eth0 ``` ```bash adguardvpn-cli config set-bound-if-override "" ``` -------------------------------- ### Log out of AdGuard VPN CLI Source: https://github.com/adguardteam/adguardvpncli/blob/master/README.md Use this command to log out of your current AdGuard VPN session. ```bash adguardvpn-cli logout ``` -------------------------------- ### VPN Status Source: https://github.com/adguardteam/adguardvpncli/blob/master/README.md Displays the current status of the AdGuard VPN service. ```APIDOC ## VPN Status ### Endpoint `adguardvpn-cli status` ### Description Display the current status of the VPN service. ``` -------------------------------- ### Disconnect from AdGuard VPN Source: https://context7.com/adguardteam/adguardvpncli/llms.txt Terminates the active VPN connection and stops the VPN service. ```bash adguardvpn-cli disconnect ``` -------------------------------- ### Disconnect from VPN Source: https://github.com/adguardteam/adguardvpncli/blob/master/README.md Stops the AdGuard VPN service. ```APIDOC ## Disconnect from VPN ### Endpoint `adguardvpn-cli disconnect` ### Description Stop the VPN service. ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.