Repository files navigation

wgcf is an unofficial, cross-platform CLI forCloudflare Warp

• Register new account
• Change license key to use existing Warp+ subscription
• Generate WireGuard profile
• Check account status
• Print trace information to debug Warp/Warp+ status

You can find pre-compiled binaries on thereleases page.

Runwgcf in a terminal without any arguments to display the help screen. All commands and parameters are documented.

Run the following command in a terminal:

wgcf register

The new account will be saved underwgcf-account.toml

Run the following command in a terminal:

wgcf generate

The WireGuard profile will be saved underwgcf-profile.conf. For more information on how to use it, please check the officialWireGuard Quick Start.

To ensure maximum compatibility, the generated profile will have a MTU of 1280, just like the official Android app. If you are experiencing performance issues, you may be able to improve your speed by increasing this value. For more information, please check#40.

If you have an existing Warp+ subscription, for example on your phone, you can bind the account generated by this tool to your phone's account, sharing its Warp+ status. Please note that there is a limit of 5 maximum devices linked at a time. You can remove linked devices from the 1.1.1.1 app on your phone.

First, get your Warp+ account license key. To view it on Android:

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

Now, back to wgcf.

wgcf register

Immediately, before running any other commands, add your key towgcf-account.toml. Finally, run:

wgcf updatewgcf generate

Run the following command in a terminal:

wgcf status

Connect to the WireGuard profilegenerated by this tool, then run:

wgcf trace

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

• api_tests - Tests for API documentation generation
• spec_format - OpenAPI3 specification formatter to post-process the spec generated by Optic

This project usesOptic to automatically generate API documentation using the tests defined inapi_tests. These tests cover all endpoints used by wgcf. The documentation is exported as an OpenAPI3specification, which is then used withopenapi-generator to generate the Go client API code underwgcf/openapi.

To update the API documentation,install Optic, then run:

api start

Resolve and save all the differences in the Web UI.

To regenerate the Go client API code,install openapi-generator, then run:

bash generate-api.sh

This script supports both Linux and WSL.

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 athttps://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.