tosunkaya / wgcf

Generate WireGuard profile from Cloudflare Warp account

wgcf

wgcf is a utility for Cloudflare Warp that allows you to create and manage accounts, assign license keys, and generate WireGuard profiles.

Features

• Register new Cloudflare Warp device and account
• Update account to allow connection via WireGuard
• Update account with new license key, sharing Warp+ status with up to 5 devices
• Generate WireGuard profile
• Check Cloudflare device status
• Print trace information to debug Warp/Warp+ status

Download

You can find pre-compiled binaries on the releases page.

Usage

Run wgcf in a terminal without any arguments to display the help screen, all commands and parameters are documented.

Register new account

Run the following command in a terminal:

wgcf register

The new account will be saved under wgcf-account.toml

Generate WireGuard profile

Register an account if you haven't already. Then, run:

wgcf generate

The WireGuard profile will be saved under wgcf-profile.conf

Change license key

If you have an existing account with Warp+, for an example on your phone, you can apply its license key to the account generated by this tool and share your Warp+ status. Please note that there is a maximum limit of 5 active linked devices at a time.

First, get your Warp+ account license key. To see the license key on Android:

1. Open the 1.1.1.1 app
2. Click on the hamburger menu button on the top-right corner
3. Navigate to: Account > Key

Register an account if you haven't already. Finally, edit wgcf-account.toml directly with the new license key and run the update command:

wgcf update

or use an environment variable:

WGCF_LICENSE_KEY="123412341234" wgcf update

The license will be applied remotely, and a new private key will be created for the updated account. Re-generate your WireGuard profile to use the updated account.

Check device status

Run the following command in a terminal:

wgcf status

Verify Warp/Warp+ works

Connect to the WireGuard profile generated by this tool, then run:

wgcf trace

If you look at the last line, it should say warp=on or warp=plus, depending on whether you have Warp or Warp+ respectively.

Notice of Non-Affiliation and Disclaimer

We are not affiliated, associated, authorized, endorsed by, or in any way officially connected with Cloudflare, or any of its subsidiaries or its affiliates. The official Cloudflare website can be found at https://www.cloudflare.com/.

The names Cloudflare Warp and Cloudflare as well as related names, marks, emblems and images are registered trademarks of their respective owners.