Referência de Comandos da CLI do FreeGuard

A CLI do FreeGuard fornece um conjunto completo de comandos para gerenciar sua conexão VPN, assinatura e configuração a partir do terminal. Cada comando suporta saída --json para scripts e integração com agentes de IA.

Flags Globais

Estas flags funcionam com qualquer comando:

Flag	Description
`--json`	Saída em formato JSON (compatível com agentes)
`--quiet`, `-q`	Modo silencioso, exibe apenas os resultados
`--verbose`, `-v`	Saída detalhada com informações de depuração
`--no-color`	Desativar saída colorida
`--lang <code>`	Idioma da interface (`auto`, `en`, `zh`, `ja`, etc.)
`--config <path>`	Usar um arquivo de configuração específico

Conexão

`freeguard connect`

Conectar a um servidor VPN. Sem argumentos, seleciona automaticamente o nó disponível mais rápido.

# Auto-connect to the best server
freeguard connect

# Connect to a specific node by ID
freeguard connect us-new-01

# Connect to the best server in a country
freeguard connect --country JP

# Use a specific protocol
freeguard connect --protocol anytls

# Enable TUN mode (requires sudo/admin)
freeguard connect --tun

Saída legível para humanos:

✓ Connected to United States - New York (us-new-01)
  Protocol: anytls | Latency: 42ms
  Proxy: 127.0.0.1:7890 (HTTP/SOCKS5)

Saída JSON:

freeguard connect --json

{"status": "connected", "node": "us-new-01", "protocol": "anytls", "latency_ms": 42}

Flags:

Flag	Description
`--country <code>`	Conectar ao melhor nó neste país (ISO 3166-1 alpha-2)
`--protocol <name>`	Protocolo preferido (`anytls`, `hysteria2`, `vless`, etc.)
`--tun`	Usar TUN mode para VPN em todo o sistema (requer privilégios elevados)

`freeguard disconnect`

Desconectar do servidor VPN atual.

freeguard disconnect

✓ Disconnected

freeguard disconnect --json

{"status": "disconnected"}

`freeguard status`

Mostrar o status atual da conexão e as estatísticas de tráfego.

freeguard status

FreeGuard VPN Status
────────────────────
Status:     ● Connected
Node:       United States - New York (us-new-01)
Protocol:   anytls
Latency:    42ms
Upload:     1.2 MB/s
Download:   15.8 MB/s
Duration:   2h 15m
Mode:       System Proxy (HTTP/SOCKS5)

freeguard status --json

{
  "connected": true,
  "node": {"id": "us-new-01", "name": "United States - New York", "country": "US"},
  "protocol": "anytls",
  "latency_ms": 42,
  "traffic": {"upload_bps": 1258291, "download_bps": 16569754},
  "duration_seconds": 8100,
  "mode": "system_proxy",
  "proxy_port": {"mixed": 7890}
}

Autenticação

`freeguard login`

Autenticar com o FreeGuard. Suporta verificação por email (nenhuma conta necessária) ou login com conta FreeGuard.

Login por email (recomendado):

# Step 1: Request verification code
freeguard login --email [email protected] --send-code

# Step 2: Enter the code
freeguard login --email [email protected] --code 123456

✓ Logged in successfully!
✓ Found 1 active subscription (Pro Plan, expires 2026-12-01)

Login com conta (abre o navegador):

freeguard login --account

Flags:

Flag	Description
`--email <address>`	Fazer login com verificação por email
`--send-code`	Enviar código de verificação para o email
`--code <digits>`	Enviar o código de verificação de 6 dígitos
`--account`	Fazer login com a conta FreeGuard via OAuth no navegador

`freeguard logout`

Limpar as credenciais armazenadas e desconectar, se estiver conectado no momento.

freeguard logout

✓ Logged out. Credentials cleared.

Assinatura

`freeguard subscribe list`

Ver os planos de assinatura disponíveis e o status atual da sua assinatura.

freeguard subscribe list

Your Subscription
─────────────────
Plan:       Pro
Status:     Active
Expires:    2026-12-01
Traffic:    450 GB / Unlimited

Available Plans
───────────────
Plan        Monthly   Quarterly   Annual
Basic       $4.99     $12.99      $39.99
Pro         $9.99     $24.99      $79.99

freeguard subscribe list --json

{
  "current": {"plan": "pro", "status": "active", "expires": "2026-12-01"},
  "plans": [
    {"name": "basic", "prices": {"monthly": 4.99, "quarterly": 12.99, "annual": 39.99}},
    {"name": "pro", "prices": {"monthly": 9.99, "quarterly": 24.99, "annual": 79.99}}
  ]
}

`freeguard subscribe create`

Criar uma nova assinatura. Abre o navegador para concluir o pagamento via Stripe ou criptomoeda.

# Interactive plan selection
freeguard subscribe create

# Specify plan directly
freeguard subscribe create --plan pro --email [email protected]

Flags:

Flag	Description
`--plan <name>`	Plano de assinatura (`basic`, `pro`)
`--email <address>`	Email para entrega da assinatura

Configuração

`freeguard config get`

Ler um valor de configuração.

freeguard config get proxy.port

freeguard config get proxy.port --json

{"key": "proxy.port", "value": 7890}

`freeguard config set`

Alterar um valor de configuração.

freeguard config set proxy.port 8080

✓ proxy.port set to 8080

Chaves de configuração comuns:

Key	Default	Description
`proxy.port`	`7890`	Porta do Proxy HTTP/SOCKS5
`proxy.mode`	`rule`	Modo do Proxy: `rule`, `global`, `direct`
`core.api_port`	`9090`	Porta da API do Mihomo
`core.pinned_version`	(empty)	Fixar o mihomo a uma versão específica
`dns.provider`	`auto`	Provedor de DNS
`update.auto_check`	`true`	Verificar atualizações na inicialização

`freeguard config edit`

Abrir o arquivo de configuração no seu editor padrão.

freeguard config edit

Diagnóstico

`freeguard doctor`

Executar uma verificação abrangente do ambiente para diagnosticar problemas.

freeguard doctor

FreeGuard Environment Check
───────────────────────────
✓ OS:              macOS 15.2 (arm64)
✓ CLI version:     v1.0.0
✓ Core version:    mihomo v1.19.21
✓ Config dir:      ~/.freeguard/
✓ Credentials:     Logged in (email: u***@example.com)
✓ Subscription:    Active (expires 2026-12-01)
✓ Network:         Internet reachable
✓ DNS:             Working (8.8.8.8)
✗ TUN permission:  Not available (run with sudo for TUN mode)
✓ Port 7890:       Available
✓ GeoIP database:  Up to date (2026-03-15)

Result: 10/11 checks passed. TUN mode requires elevated privileges.

freeguard doctor --json

{
  "checks": [
    {"name": "os", "status": "pass", "detail": "macOS 15.2 (arm64)"},
    {"name": "cli_version", "status": "pass", "detail": "v1.0.0"},
    {"name": "tun_permission", "status": "fail", "detail": "Not available (run with sudo)"}
  ],
  "passed": 10,
  "total": 11
}

`freeguard version`

Exibir informações de versão da CLI e do core engine.

freeguard version

FreeGuard CLI v1.0.0
Core: mihomo v1.19.21
OS: darwin/arm64

freeguard version --json

{"cli": "1.0.0", "core": "1.19.21", "os": "darwin", "arch": "arm64"}

Avançado (Phase 2+)

Os seguintes comandos estão planejados para versões futuras.

`freeguard node list`

Listar os nós VPN disponíveis com filtragem e ordenação.

freeguard node list
freeguard node list --country US --sort latency

Flags:

Flag	Description
`--country <code>`	Filtrar por código de país
`--protocol <name>`	Filtrar por protocolo
`--sort <field>`	Ordenar por `speed`, `latency` ou `load`

`freeguard node test`

Testar a latência e a velocidade dos nós.

freeguard node test us-new-01
freeguard node test --all

`freeguard monitor`

Exibir monitoramento de tráfego em tempo real no terminal.

freeguard monitor

↑ 0.8 MB/s  ↓ 12.3 MB/s  Connections: 47

`freeguard core`

Gerencie o mecanismo mihomo subjacente.

# Check core status
freeguard core status

# Update to latest core version
freeguard core update

# Restart the core engine
freeguard core restart

`freeguard shell`

Entre no modo REPL interativo para executar vários comandos em uma sessão.

freeguard shell

`freeguard dashboard`

Abra o painel TUI com gráficos de tráfego em tempo real, lista de nós e detalhes da conexão.

freeguard dashboard

Last updated: March 2026