wgcf

该介绍目前仅提供英文版本。

A cross-platform, unofficial CLI for Cloudflare Warp

Overview

wgcf is a command-line tool that allows you to interact with Cloudflare’s Warp service. It enables you to register new Warp accounts, generate WireGuard profiles for use with any WireGuard client, check account status, and manage Warp+ subscriptions—all from a simple CLI interface that works across multiple operating systems.

Key Features

• 👤 Account Registration: Create new Cloudflare Warp accounts with a simple command
• 📄 WireGuard Profile Generation: Automatically generate ready-to-use WireGuard configurations
• 🔑 License Key Management: Change license keys to use existing Warp+ subscriptions
• 📊 Account Status: Check your device registration status and quota
• 🔍 Trace Information: Debug Warp/Warp+ connectivity with detailed trace data
• 💻 Cross-Platform Support: Works on Windows, macOS, Linux, and more

How It Works

wgcf interacts directly with Cloudflare’s API to:

1. Register new devices with the Warp service
2. Generate standard WireGuard configuration profiles
3. Link accounts to existing Warp+ subscriptions
4. Verify connectivity and proper functioning of the Warp service

Quick Start

Download

Pre-compiled binaries are available on the GitHub releases page.

Register a New Account

wgcf register

This creates a new account configuration file saved as wgcf-account.toml.

Generate WireGuard Profile

wgcf generate

This generates a WireGuard configuration file saved as wgcf-profile.conf that can be imported into any WireGuard client.

Usage Examples

Add a Warp+ License Key

If you have a Warp+ subscription (purchased through the official 1.1.1.1 app):

1. Obtain your license key from the 1.1.1.1 app (Account > Key)
2. Create a new wgcf account:

   wgcf register

3. Edit the wgcf-account.toml file to add your license key
4. Update your account and generate a profile:

   wgcf update
   wgcf generate

Check Account Status

wgcf status

Verify Warp Connectivity

After connecting to your WireGuard profile:

wgcf trace

The output should show warp=on or warp=plus depending on your subscription type.

Why Use wgcf?

1. Flexibility: Use Cloudflare Warp with any standard WireGuard client
2. Portability: Run on any platform that supports WireGuard
3. Privacy: Secure your connection with WireGuard encryption and Cloudflare’s privacy features
4. Performance: Access Cloudflare’s global network for improved speed and reliability
5. Automation: Easily script or automate Warp account management

System Requirements

• Any operating system that can run the Go binary or has a compatible pre-compiled release
• WireGuard client (to use the generated profiles)
• Internet connection

License

This project is licensed under the MIT License.

Note: wgcf is an unofficial tool and not affiliated with, associated with, authorized by, endorsed by, or in any way officially connected with Cloudflare.