Довідник команд FreeGuard CLI

FreeGuard CLI надає повний набір команд для керування вашим VPN-з’єднанням, підпискою та конфігурацією з термінала. Кожна команда підтримує вивід --json для сценаріїв і інтеграції з AI-агентами.

Глобальні прапорці

Ці прапорці працюють з будь-якою командою:

Прапорець	Опис
`--json`	Вивід у форматі JSON (зручно для агентів)
`--quiet`, `-q`	Тихий режим, виводити лише результати
`--verbose`, `-v`	Докладний вивід з інформацією для налагодження
`--no-color`	Вимкнути кольоровий вивід
`--lang <code>`	Мова інтерфейсу (`auto`, `en`, `zh`, `ja`, etc.)
`--config <path>`	Використати певний файл конфігурації

Підключення

`freeguard connect`

Підключитися до VPN-сервера. Без аргументів автоматично обирає найшвидший доступний вузол.

# Автопідключення до найкращого сервера
freeguard connect

# Підключення до конкретного вузла за ID
freeguard connect us-new-01

# Підключення до найкращого сервера в країні
freeguard connect --country JP

# Використати певний протокол
freeguard connect --protocol anytls

# Увімкнути TUN Mode (потрібен sudo/admin)
freeguard connect --tun

Людський вивід:

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

JSON-вивід:

freeguard connect --json

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

Прапорці:

Прапорець	Опис
`--country <code>`	Підключитися до найкращого вузла в цій країні (ISO 3166-1 alpha-2)
`--protocol <name>`	Бажаний протокол (`anytls`, `hysteria2`, `vless`, etc.)
`--tun`	Використати TUN Mode для системного VPN (потрібні підвищені привілеї)

`freeguard disconnect`

Від’єднатися від поточного VPN-сервера.

freeguard disconnect

✓ Disconnected

freeguard disconnect --json

{"status": "disconnected"}

`freeguard status`

Показати поточний стан з’єднання та статистику трафіку.

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

Автентифікація

`freeguard login`

Автентифікуватися у FreeGuard. Підтримує перевірку через email (обліковий запис не потрібен) або вхід до облікового запису FreeGuard.

Вхід через email (рекомендовано):

# Крок 1: Запросити код підтвердження
freeguard login --email [email protected] --send-code

# Крок 2: Ввести код
freeguard login --email [email protected] --code 123456

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

Вхід через обліковий запис (відкриває браузер):

freeguard login --account

Прапорці:

Прапорець	Опис
`--email <address>`	Вхід із перевіркою через email
`--send-code`	Надіслати код підтвердження на email
`--code <digits>`	Надіслати 6-значний код підтвердження
`--account`	Увійти через обліковий запис FreeGuard за допомогою OAuth у браузері

`freeguard logout`

Очистити збережені облікові дані та від’єднатися, якщо наразі є з’єднання.

freeguard logout

✓ Logged out. Credentials cleared.

Підписка

`freeguard subscribe list`

Переглянути доступні тарифні плани підписки та поточний статус підписки.

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`

Створити нову підписку. Відкриває ваш браузер для завершення оплати через Stripe або криптовалюту.

# Інтерактивний вибір плану
freeguard subscribe create

# Вказати план напряму
freeguard subscribe create --plan pro --email [email protected]

Прапорці:

Прапорець	Опис
`--plan <name>`	Тарифний план підписки (`basic`, `pro`)
`--email <address>`	Email для доставки підписки

Конфігурація

`freeguard config get`

Зчитати значення конфігурації.

freeguard config get proxy.port

freeguard config get proxy.port --json

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

`freeguard config set`

Змінити значення конфігурації.

freeguard config set proxy.port 8080

✓ proxy.port set to 8080

Поширені ключі конфігурації:

Ключ	Значення за замовчуванням	Опис
`proxy.port`	`7890`	Порт HTTP/SOCKS5 proxy
`proxy.mode`	`rule`	Режим Proxy: `rule`, `global`, `direct`
`core.api_port`	`9090`	Порт API Mihomo
`core.pinned_version`	(порожньо)	Зафіксувати mihomo на певній версії
`dns.provider`	`auto`	Провайдер DNS
`update.auto_check`	`true`	Перевіряти наявність оновлень під час запуску

`freeguard config edit`

Відкрити файл конфігурації у вашому редакторі за замовчуванням.

freeguard config edit

Діагностика

`freeguard doctor`

Запустити повну перевірку середовища для діагностики проблем.

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`

Показати інформацію про версію CLI та основного рушія.

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

Додатково (Phase 2+)

Наступні команди заплановані для майбутніх релізів.

`freeguard node list`

Показати список доступних VPN-вузлів із фільтрацією та сортуванням.

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

Прапорці:

Прапорець	Опис
`--country <code>`	Фільтрувати за кодом країни
`--protocol <name>`	Фільтрувати за протоколом
`--sort <field>`	Сортувати за `speed`, `latency` або `load`

`freeguard node test`

Перевірити затримку та швидкість вузлів.

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

`freeguard monitor`

Показувати моніторинг трафіку в реальному часі у вашому терміналі.

freeguard monitor

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

`freeguard core`

Керує базовим двигуном mihomo.

# Check core status
freeguard core status

# Update to latest core version
freeguard core update

# Restart the core engine
freeguard core restart

`freeguard shell`

Перейдіть у інтерактивний режим REPL для запуску кількох команд в одному сеансі.

freeguard shell

`freeguard dashboard`

Відкрийте TUI-дашборд із графіками трафіку в реальному часі, списком вузлів і деталями з’єднання.

freeguard dashboard

Last updated: March 2026