Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/virb3/wgcf
🚤 Cross-platform, unofficial CLI for Cloudflare Warp
https://github.com/virb3/wgcf
client cloudflare plus security vpn warp wireguard
Last synced: 6 days ago
JSON representation
🚤 Cross-platform, unofficial CLI for Cloudflare Warp
- Host: GitHub
- URL: https://github.com/virb3/wgcf
- Owner: ViRb3
- License: mit
- Created: 2020-04-13T20:41:19.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-12-09T20:00:27.000Z (13 days ago)
- Last Synced: 2024-12-09T20:44:30.983Z (13 days ago)
- Topics: client, cloudflare, plus, security, vpn, warp, wireguard
- Language: Go
- Homepage:
- Size: 497 KB
- Stars: 6,327
- Watchers: 66
- Forks: 703
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# wgcf
> wgcf is an unofficial, cross-platform CLI for [Cloudflare Warp](https://1.1.1.1/)
## 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](https://github.com/ViRb3/wgcf/releases).
## 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](https://www.wireguard.com/quickstart/).
#### 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](https://github.com/ViRb3/wgcf/issues/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 on the top-right corner
3. Navigate to: `Account` > `Key`
Now, back to wgcf.
> [!WARNING]
> If you have an existing account, you will need to delete it and create a new one ([!355](https://github.com/ViRb3/wgcf/pull/355), [!425](https://github.com/ViRb3/wgcf/pull/425)). Otherwise, just run the same command to make your first account:
>
> ```wgcf register
> wgcf register
> ```
Immediately, before running any other commands, add your key to `wgcf-account.toml`. Finally, run:
```bash
wgcf update
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](#generate-wireguard-profile) 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.
## Development
### Sub-packages
- [api_tests](api_tests/main.go) - Tests for API documentation generation
- [spec_format](spec_format/main.go) - OpenAPI3 specification formatter to post-process the spec generated by Optic
### API
This project uses [Optic](https://github.com/opticdev/optic) to automatically generate API documentation using the tests defined in [api_tests](api_tests/main.go). These tests cover all endpoints used by wgcf. The documentation is exported as an OpenAPI3 [specification](openapi-spec.json), which is then used with [openapi-generator](https://openapi-generator.tech/) to generate the Go client API code under [wgcf/openapi](openapi/client.go).
To update the API documentation, [install Optic](https://github.com/opticdev/optic/releases/latest), then run:
```bash
api start
```
Resolve and save all the differences in the Web UI.
To regenerate the Go client API code, [install openapi-generator](https://openapi-generator.tech/docs/installation), then run:
```bash
bash generate-api.sh
```
This script supports both Linux and WSL.
## 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.