{"id":15030142,"url":"https://github.com/virb3/wgcf","last_synced_at":"2026-10-18T22:27:07.982Z","repository":{"id":37920518,"uuid":"255437195","full_name":"ViRb3/wgcf","owner":"ViRb3","description":"🚤 Cross-platform, unofficial CLI for Cloudflare Warp","archived":false,"fork":false,"pushed_at":"2026-09-18T18:00:28.000Z","size":647,"stargazers_count":8763,"open_issues_count":29,"forks_count":869,"subscribers_count":72,"default_branch":"master","last_synced_at":"2026-10-04T09:28:48.205Z","etag":null,"topics":["client","cloudflare","plus","security","vpn","warp","wireguard"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ViRb3.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-04-13T20:41:19.000Z","updated_at":"2026-10-04T07:29:08.000Z","dependencies_parsed_at":"2024-04-08T20:10:42.259Z","dependency_job_id":"793c2630-d04e-47c5-9244-d6af11dd49f1","html_url":"https://github.com/ViRb3/wgcf","commit_stats":{"total_commits":206,"total_committers":6,"mean_commits":"34.333333333333336","dds":"0.45145631067961167","last_synced_commit":"46c823974d14d00cdc39c5b1f396546e294753a7"},"previous_names":[],"tags_count":46,"template":false,"template_full_name":null,"purl":"pkg:github/ViRb3/wgcf","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ViRb3%2Fwgcf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ViRb3%2Fwgcf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ViRb3%2Fwgcf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ViRb3%2Fwgcf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ViRb3","download_url":"https://codeload.github.com/ViRb3/wgcf/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ViRb3%2Fwgcf/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":344872684,"owners_count":38342757,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-10-03T21:59:58.778Z","status":"online","status_checked_at":"2026-10-18T02:00:06.448Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["client","cloudflare","plus","security","vpn","warp","wireguard"],"created_at":"2024-09-24T20:12:33.674Z","updated_at":"2026-10-18T22:27:07.976Z","avatar_url":"https://github.com/ViRb3.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# wgcf\n\u003e wgcf is an unofficial, cross-platform CLI for [Cloudflare Warp](https://1.1.1.1/)\n\n![](https://img.shields.io/drone/build/ViRb3/wgcf)\n![](https://img.shields.io/github/issues/ViRb3/wgcf)\n![](https://img.shields.io/github/downloads/ViRb3/wgcf/total)\n![](https://img.shields.io/github/languages/code-size/ViRb3/wgcf)\n\n## Features\n- Register new account\n- Change license key to use existing Warp+ subscription\n- Generate WireGuard profile\n- Check account status\n- Print trace information to debug Warp/Warp+ status\n\n## Download\nYou can find pre-compiled binaries on the [releases page](https://github.com/ViRb3/wgcf/releases).\n\n## Usage\nRun `wgcf` in a terminal without any arguments to display the help screen. All commands and parameters are documented.\n\n### Register new account\nRun the following command in a terminal:\n```bash\nwgcf register\n```\nThe new account will be saved under `wgcf-account.toml`\n\n### Generate WireGuard profile\nRun the following command in a terminal:\n```bash\nwgcf generate\n```\nThe 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/).\n\nTo send periodic packets that keep NAT mappings alive, use the optional keepalive flag:\n```bash\nwgcf generate --keepalive       # defaults to 25 seconds\nwgcf generate --keepalive=60    # uses the specified interval\n```\nThis adds `PersistentKeepalive` to the profile's `[Peer]` section. The setting is omitted by default.\n\n#### Maximum transmission unit (MTU)\nTo 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).\n\n### Add a license key\n\nIf 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.\n\n\u003e [!CAUTION]\n\u003e 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.\n\nFirst, get your Warp+ account license key. To view it on Android:\n1. Open the `1.1.1.1` app\n2. Click on the hamburger menu button in the top-right corner \n3. Navigate to: `Account` \u003e `Key`\n\nNow, back to wgcf.\n\n\u003e [!WARNING]\n\u003e 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:\n\u003e\n\u003e ```wgcf register\n\u003e wgcf register\n\u003e ```\n\u003e Then immediately proceed with the steps below, without running any other commands. For more details, check [!85](https://github.com/ViRb3/wgcf/issues/85)\n\nRun the following commands:\n\n```bash\nwgcf update --license-key \"YOUR_LICENSE_KEY_GOES_HERE\"\nwgcf generate\n```\n\n\n### Check device status\nRun the following command in a terminal:\n```bash\nwgcf status\n```\n\n### Verify Warp/Warp+ works\nConnect to the WireGuard profile [generated](#generate-wireguard-profile) by this tool, then run:\n```bash\nwgcf trace\n```\nIf you look at the last line, it should say `warp=on` or `warp=plus`, depending on whether you have Warp or Warp+ respectively.\n\n\u003e [!WARNING]\n\u003e If you're seeing `warp=on` even after you bound a Warp+ license key, you are likely experiencing a known bug, please refer to the [Add a license key](#add-a-license-key) section.\n\n## Development\nThe API client code is auto-generated from the OpenAPI spec [openapi-spec.yml](openapi-spec.yml) and stored under the [openapi/](openapi/) package. Do not touch any code under that package, instead, change the spec file and regenerate the API client code. To do this, [install openapi-generator](https://openapi-generator.tech/docs/installation), then run:\n\n```bash\ngo generate\n```\n## Notice of Non-Affiliation and Disclaimer\nWe 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/.\n\nThe names Cloudflare Warp and Cloudflare as well as related names, marks, emblems and images are registered trademarks of their respective owners.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvirb3%2Fwgcf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvirb3%2Fwgcf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvirb3%2Fwgcf/lists"}