LinuxCommandLibrary

warp-cli

Connect and manage Cloudflare WARP

TLDR

Register the current device to WARP (must be run before first connection)

$ warp-cli registration new
copy

Connect to WARP
$ warp-cli connect
copy

Disconnect from WARP
$ warp-cli disconnect
copy

Display the WARP connection status
$ warp-cli status
copy

Switch to a specific mode
$ warp-cli set-mode [mode]
copy

Display help
$ warp-cli help
copy

Display help for a subcommand
$ warp-cli help [subcommand]
copy

SYNOPSIS

warp-cli [command] [options]

PARAMETERS

register
    Registers the device with Cloudflare WARP using a team name.

disconnect
    Disconnects from the WARP VPN.

connect
    Connects to the WARP VPN.

status
    Displays the current status of the WARP connection.

settings
    Displays the current WARP settings.

teams-enroll
    Enrolls into the Cloudflare teams account.

warp-stats
    Shows warp statistics.

help
    Displays help information about the available commands and options.

version
    Displays version information.

DESCRIPTION

The warp-cli command provides a command-line interface to control the Cloudflare WARP client on Linux systems. It allows users to connect to and disconnect from the WARP VPN, manage the WARP settings, view connection status, and perform other related functions without relying on the graphical user interface. This tool is particularly useful for automating WARP connections in scripts, managing WARP on headless servers, and troubleshooting connection issues.

The `warp-cli` tool is an essential companion to the GUI, offering granular control for advanced users or system administrators. It provides control over device registration and allows management of settings directly from the terminal. Using `warp-cli` the WARP service can be queried and controlled, allowing the user to see the status of the connection, register the device with a Cloudflare account and manage the connection to the WARP service.

CAVEATS

The warp-cli tool relies on the Cloudflare WARP client being properly installed and running in the background. Root privileges may be required for some commands, particularly those that modify system-wide settings. Some parameters and features are only available in certain WARP client versions.

EXAMPLES

warp-cli status: Shows the current connection status.
warp-cli connect: Connects to WARP VPN.
warp-cli disconnect: Disconnects from the WARP VPN.
sudo warp-cli register <team_name>: Registers with a WARP team.

HISTORY

The warp-cli command was developed alongside the Cloudflare WARP client to provide a command-line interface for managing the VPN connection. It was created to cater to users who prefer command-line tools for automation and system administration. The usage has grown steadily with increased adoption of the WARP VPN across various platforms.

SEE ALSO

ip(8), route(8), wg(8)

Copied to clipboard