wgcf

wgcf

wgcf é uma CLI não oficial e multiplataforma para Cloudflare Warp

Características

• Registrar nova conta

• Altere a chave de licença para usar a assinatura Warp+ existente

• Gerar perfil WireGuard

• Verifique o status da conta

• Imprimir informações de rastreamento para depurar o status Warp/Warp+

Download

Você pode encontrar binários pré-compilados na página de lançamentos.

Uso

Execute wgcf em um terminal sem argumentos para exibir a tela de ajuda. Todos os comandos e parâmetros estão documentados.

Registrar nova conta

Execute o seguinte comando em um terminal:

 registro wgcf

A nova conta será salva em wgcf-account.toml

Gerar perfil WireGuard

Execute o seguinte comando em um terminal:

 gerar wgcf

O perfil WireGuard será salvo em wgcf-profile.conf . Para obter mais informações sobre como usá-lo, consulte o início rápido oficial do WireGuard.

Unidade máxima de transmissão (MTU)

Para garantir a máxima compatibilidade, o perfil gerado terá um MTU de 1280, assim como o aplicativo oficial para Android. Se você estiver enfrentando problemas de desempenho, poderá melhorar sua velocidade aumentando esse valor. Para obter mais informações, verifique o número 40.

Adicione uma chave de licença

Se você já possui uma assinatura Warp+, por exemplo em seu telefone, você pode vincular a conta gerada por esta ferramenta à conta do seu telefone, compartilhando seu status Warp+. Observe que há um limite atual de no máximo 5 dispositivos vinculados ativos por vez.

Primeiro, obtenha a chave de licença da sua conta Warp+. Para visualizá-lo no Android:

1. Abra o aplicativo 1.1.1.1

2. Clique no botão do menu de hambúrguer no canto superior direito

3. Navegue até: Account > Key

Agora, de volta ao wgcf.

⚠️ Se você já tiver uma conta, precisará excluí-la e criar uma nova (!355, !425):

wgcf register

Em seguida, adicione imediatamente sua chave a wgcf-account.toml . Finalmente, execute:

 atualização do wgcf
gerar wgcf

Verifique o status do dispositivo

Execute o seguinte comando em um terminal:

 status do wgcf

Verifique se Warp/Warp+ funciona

Conecte-se ao perfil WireGuard gerado por esta ferramenta e execute:

 rastreamento wgcf

Se você olhar a última linha, deverá dizer warp=on ou warp=plus , dependendo se você tem Warp ou Warp+ respectivamente.

Desenvolvimento

Subpacotes

• api_tests – Testes para geração de documentação de API

• spec_format - Formatador de especificação OpenAPI3 para pós-processar a especificação gerada pelo Optic

API

Este projeto usa Optic para gerar automaticamente documentação de API usando os testes definidos em api_tests. Esses testes cobrem todos os endpoints usados ​​pelo wgcf. A documentação é exportada como uma especificação OpenAPI3, que é então usada com openapi-generator para gerar o código da API do cliente Go em wgcf/openapi.

Para atualizar a documentação da API, instale o Optic e execute:

 início da API

Resolva e salve todas as diferenças na UI da Web.

Para regenerar o código da API do cliente Go, instale o openapi-generator e execute:

 bash gerar-api.sh

Este script oferece suporte a Linux e WSL.

Aviso de não afiliação e isenção de responsabilidade

Não somos afiliados, associados, autorizados, endossados ​​ou de qualquer forma oficialmente conectados à Cloudflare ou a qualquer uma de suas subsidiárias ou afiliadas. O site oficial da Cloudflare pode ser encontrado em https://www.cloudflare.com/.

Os nomes Cloudflare Warp e Cloudflare, bem como nomes, marcas, emblemas e imagens relacionados são marcas registradas de seus respectivos proprietários.