+1
Daily
8,903
stars
883
forks
72
watchers
428
prs
210
issues
51
releases
README
wgcf wgcf is an unofficial, cross-platform CLI for Cloudflare Warp ! ! ! ! Features - 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 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: bash wgcf register The new account will be saved under wgcf-account.toml Generate WireGuard profile Run the following command in a terminal: bash wgcf generate The WireGuard profile will be saved under wgcf-profile.conf. For more information on how to use it, please check the official WireGuard Quick Start. To send periodic packets that keep NAT mappings alive, use the optional keepalive flag: bash wgcf generate --keepalive defaults to 25 seconds wgcf generate --keepalive=60 uses the specified interval This adds PersistentKeepalive to the profile's [Peer] section. The setting is omitted by default. Maximum transmission unit (MTU) 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. Add a license key 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. [!CAUTION] Only subscriptions purchased directly from the official 1.1.1.1 app are supported. Keys obtained by any other means, including referrals, will not work and will not be supported. First, get your Warp+ account license key. To view it on Android: 1. Open the 1.1.1.1 app 2. Click on the hamburger menu button in the top-right corner 3. Navigate to: Account Key Now, back to wgcf. [!WARNING] There's a bug on Cloudflare's side that prevents existing accounts from getting Warp+ even after you bind a correct license key. If you have ever connected to Warp VPN, then your account is affected. You will need to make a new account via: wgcf register wgcf register Then immediately proceed with the steps below, without running any other commands. For more details, check !85 Run the following commands: bash wgcf update --license-key "YOUR_LICENSE_KEY_GOES_HERE" wgcf generate Check device status Run the following command in a terminal: bash wgcf status Verify Warp/Warp+ works Connect to the WireGuard profile generated by this tool, then run: bash 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. [!
Top issues
#158Internet access does not work (abuse prevention)100 comments · 2022-03-03#50Internet access does not work (system issue)77 comments · 2020-10-24#56Support Teams/Zero Trust35 comments · 2020-11-21#85WARP+ not work34 comments · 2021-04-15#279Alternative Endpoint15 comments · 2023-04-17#515Some API endpoints return 500 Internal Server Error since Aug 7, 202512 comments · 2025-08-09#42Exclude private IPs from Wireguard profile11 comments · 2020-08-26#79Possible to build for Android (arm64)?5 comments · 2021-03-01
Latest release
v2.3.1 v2.3.1 2026-10-112.3.1 (2026-10-11) Bug Fixes make SourceDevice key_type and tunnel_type optional (3ae65b0)