Dokumentacja poleceń FreeGuard CLI

FreeGuard CLI udostępnia pełny zestaw poleceń do zarządzania połączeniem VPN, subskrypcją i konfiguracją z poziomu terminala. Każde polecenie obsługuje wyjście --json do skryptów i integracji z agentami AI.

Flagi globalne

Te flagi działają z każdym poleceniem:

Flaga	Opis
`--json`	Wyjście w formacie JSON (przyjazne dla agenta)
`--quiet`, `-q`	Tryb cichy, wyświetlaj tylko wyniki
`--verbose`, `-v`	Szczegółowe wyjście z informacjami debugowania
`--no-color`	Wyłącz kolorowe wyjście
`--lang <code>`	Język interfejsu (`auto`, `en`, `zh`, `ja`, itd.)
`--config <path>`	Użyj określonego pliku konfiguracji

Połączenie

`freeguard connect`

Połącz z serwerem VPN. Bez argumentów automatycznie wybiera najszybszy dostępny węzeł.

# Auto-connect do najlepszego serwera
freeguard connect

# Połącz z określonym węzłem według ID
freeguard connect us-new-01

# Połącz z najlepszym serwerem w danym kraju
freeguard connect --country JP

# Użyj określonego protokołu
freeguard connect --protocol anytls

# Włącz TUN mode (wymaga sudo/admin)
freeguard connect --tun

Wyjście czytelne dla człowieka:

✓ Połączono z United States - New York (us-new-01)
  Protocol: anytls | Latency: 42ms
  Proxy: 127.0.0.1:7890 (HTTP/SOCKS5)

Wyjście JSON:

freeguard connect --json

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

Flagi:

Flaga	Opis
`--country <code>`	Połącz z najlepszym węzłem w tym kraju (ISO 3166-1 alpha-2)
`--protocol <name>`	Preferowany protokół (`anytls`, `hysteria2`, `vless`, itd.)
`--tun`	Użyj TUN mode dla systemowego VPN (wymaga podwyższonych uprawnień)

`freeguard disconnect`

Rozłącz z bieżącego serwera VPN.

freeguard disconnect

✓ Rozłączono

freeguard disconnect --json

{"status": "disconnected"}

`freeguard status`

Pokaż bieżący status połączenia i statystyki ruchu.

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}
}

Uwierzytelnianie

`freeguard login`

Uwierzytelnij się w FreeGuard. Obsługuje weryfikację przez e-mail (bez konieczności posiadania konta) lub logowanie na konto FreeGuard.

Logowanie przez e-mail (zalecane):

# Krok 1: Poproś o kod weryfikacyjny
freeguard login --email [email protected] --send-code

# Krok 2: Wprowadź kod
freeguard login --email [email protected] --code 123456

✓ Zalogowano pomyślnie!
✓ Znaleziono 1 aktywną subskrypcję (Pro Plan, wygasa 2026-12-01)

Logowanie na konto (otwiera przeglądarkę):

freeguard login --account

Flagi:

Flaga	Opis
`--email <address>`	Logowanie z weryfikacją e-mail
`--send-code`	Wyślij kod weryfikacyjny na e-mail
`--code <digits>`	Prześlij 6-cyfrowy kod weryfikacyjny
`--account`	Logowanie na konto FreeGuard przez OAuth w przeglądarce

`freeguard logout`

Wyczyść zapisane dane uwierzytelniające i rozłącz, jeśli aktualnie jest aktywne połączenie.

freeguard logout

✓ Wylogowano. Dane uwierzytelniające wyczyszczone.

Subskrypcja

`freeguard subscribe list`

Wyświetl dostępne plany subskrypcji i bieżący status subskrypcji.

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`

Utwórz nową subskrypcję. Otwiera przeglądarkę, aby dokończyć płatność przez Stripe lub kryptowalutę.

# Interaktywny wybór planu
freeguard subscribe create

# Określ plan bezpośrednio
freeguard subscribe create --plan pro --email [email protected]

Flagi:

Flaga	Opis
`--plan <name>`	Plan subskrypcji (`basic`, `pro`)
`--email <address>`	E-mail do dostarczenia subskrypcji

Konfiguracja

`freeguard config get`

Odczytaj wartość konfiguracji.

freeguard config get proxy.port

freeguard config get proxy.port --json

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

`freeguard config set`

Zmień wartość konfiguracji.

freeguard config set proxy.port 8080

✓ proxy.port ustawiono na 8080

Często używane klucze konfiguracji:

Klucz	Domyślna wartość	Opis
`proxy.port`	`7890`	Port proxy HTTP/SOCKS5
`proxy.mode`	`rule`	Tryb Proxy: `rule`, `global`, `direct`
`core.api_port`	`9090`	Port API Mihomo
`core.pinned_version`	(puste)	Przypnij mihomo do określonej wersji
`dns.provider`	`auto`	Dostawca DNS
`update.auto_check`	`true`	Sprawdzaj aktualizacje przy uruchomieniu

`freeguard config edit`

Otwórz plik konfiguracji w domyślnym edytorze.

freeguard config edit

Diagnostyka

`freeguard doctor`

Uruchom kompleksową kontrolę środowiska, aby zdiagnozować problemy.

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`

Wyświetl informacje o wersji CLI i silnika core.

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"}

Zaawansowane (Faza 2+)

Poniższe polecenia są planowane na przyszłe wydania.

`freeguard node list`

Wyświetl listę dostępnych węzłów VPN z filtrowaniem i sortowaniem.

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

Flagi:

Flaga	Opis
`--country <code>`	Filtruj według kodu kraju
`--protocol <name>`	Filtruj według protokołu
`--sort <field>`	Sortuj według `speed`, `latency` lub `load`

`freeguard node test`

Testuj opóźnienie i prędkość węzłów.

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

`freeguard monitor`

Wyświetl monitorowanie ruchu w czasie rzeczywistym w terminalu.

freeguard monitor

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

`freeguard core`

Zarządzaj podstawowym silnikiem mihomo.

# Check core status
freeguard core status

# Update to latest core version
freeguard core update

# Restart the core engine
freeguard core restart

`freeguard shell`

Wejdź w interaktywny tryb REPL, aby uruchamiać wiele poleceń w jednej sesji.

freeguard shell

`freeguard dashboard`

Otwórz panel TUI z wykresami ruchu w czasie rzeczywistym, listą węzłów i szczegółami połączenia.

freeguard dashboard

Last updated: March 2026