Home
Softono
cf-warp

cf-warp

Open source MIT JavaScript
GitHub
463
Stars
64
Forks
14
Issues
18
Watchers
3 years
Last Commit
VPN & Firewalls

About cf-warp

cf-warp is a command-line tool that generates WireGuard configuration files for Cloudflare's Warp+ VPN service. It allows users to obtain Warp+ data quotas, which it acquires by simulating referral sources since direct payment outside the 1.1.1.1 mobile app is unavailable. The tool is available in three formats: a Node.js package installable via npm or yarn, standalone executables for major platforms, and a Docker image. Users run a simple command to initialize a Warp+ account and generate a WireGuard config file that can be imported into any WireGuard client. Key features include the ability to increase Warp+ quota by specified amounts in gigabytes, link an existing Warp+ license key from the mobile 1.1.1.1 app to share data quota across devices, and store credentials locally for reuse. The generated configuration files provide a straightforward way to route traffic through Cloudflare's network on desktop or server environments where the official mobile app cannot be used. The tool is intended for users who

Platforms

Web Self-hosted

Languages

JavaScript

Links

Source Code
m
Published by
maple3142
Visit View Profile

README.md

View on GitHub

cf-warp

A simple cli to get Warp+ as WireGuard configuration

For people who just want a easy way to get a WireGuard of Warp, just download this file: https://cf-warp.maple3142.net/warp.conf. Source code of the backend can be found here.

Usage

By using this, you agree the Privacy Policy and Terms of Service of Cloudflare 1.1.1.1

With Node.js (Recommended)

Step 1

Install cf-warp globally through yarn or npm.

yarn global add cf-warp # npm i -g cf-warp

Step 2

Initialize your Warp+ account by running cf-warp command.

Example:

$ cf-warp
Your Warp credentials are located at "C:\Users\maple3142\.cf-warp\data.json", and WireGuard connection file is "C:\Users\maple3142\.cf-warp\cf-warp.conf".
You currently have 1GB Warp+ quota.
To get your current Warp+ quota, simply run "cf-warp".
To increase your Warp+ quota by 10 GB, simply run "cf-warp 10".

Step 3

Obtain cf-warp.conf from ~/.cf-warp/cf-warp.conf and use it normally.

Without Node.js

Step 1

Go ahead to releases page and download a binary for your platform.

Step 2

Open your cmd/terminal and locate the binary you just downloaded, such as cf-warp-win.exe ...

Step 3

Use it just like cf-warp installed by npm.

With Docker

Step 1

docker run --rm -v ~/.cf-warp:/root/.cf-warp maple3142/cf-warp [args]

FAQ

How does cf-warp get Warp+ quota for free?

It currently get quota by faking referrers since there is no way to pay for premium version outside of 1.1.1.1 app, but it is recommended to pay for it on your phone if you think their service is good.

How do link this to a WARP+ license from the mobile 1.1.1.1 app?

  1. Find your license key on your mobile 1.1.1.1 app
    • It should be under settings/account/key, in the form of "1a2b3d4e-1a2b3d4e-1a2b3d4e"
  2. Copy that key, and run the command:
cf-warp --license 1a2b3d4e-1a2b3d4e-1a2b3d4e #Your own license key goes here
  1. When done, the current config should be sharing the same data quota as the mobile 1.1.1.1
    • If you've paid on your phone, this config should enjoy unlimited data and WARP+.

IPv6 doesn't works in Linux by default

Due to the private tunnel local address Linux needs getaddrinfo configuration.

Thanks

https://github.com/yyuueexxiinngg/some-scripts/tree/master/cloudflare