Référence des commandes FreeGuard CLI

FreeGuard CLI fournit un ensemble complet de commandes pour gérer votre connexion VPN, votre abonnement et votre configuration depuis le terminal. Chaque commande prend en charge la sortie --json pour le scripting et l’intégration d’agents IA.

Indicateurs globaux

Ces indicateurs fonctionnent avec n’importe quelle commande :

Flag	Description
`--json`	Sortie au format JSON (compatible agents)
`--quiet`, `-q`	Mode silencieux, n’affiche que les résultats
`--verbose`, `-v`	Sortie détaillée avec informations de débogage
`--no-color`	Désactiver la sortie en couleur
`--lang <code>`	Langue de l’interface (`auto`, `en`, `zh`, `ja`, etc.)
`--config <path>`	Utiliser un fichier de configuration spécifique

Connexion

`freeguard connect`

Se connecter à un serveur VPN. Sans arguments, sélectionne automatiquement le nœud disponible le plus rapide.

# Connexion automatique au meilleur serveur
freeguard connect

# Se connecter à un nœud spécifique par ID
freeguard connect us-new-01

# Se connecter au meilleur serveur d’un pays
freeguard connect --country JP

# Utiliser un protocole spécifique
freeguard connect --protocol anytls

# Activer le mode TUN (nécessite sudo/admin)
freeguard connect --tun

Sortie lisible par un humain :

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

Sortie JSON :

freeguard connect --json

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

Flags :

Flag	Description
`--country <code>`	Se connecter au meilleur nœud dans ce pays (ISO 3166-1 alpha-2)
`--protocol <name>`	Protocole préféré (`anytls`, `hysteria2`, `vless`, etc.)
`--tun`	Utiliser le mode TUN pour un VPN à l’échelle du système (nécessite des privilèges élevés)

`freeguard disconnect`

Se déconnecter du serveur VPN actuel.

freeguard disconnect

✓ Déconnecté

freeguard disconnect --json

{"status": "disconnected"}

`freeguard status`

Afficher l’état actuel de la connexion et les statistiques de trafic.

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

Authentification

`freeguard login`

S’authentifier avec FreeGuard. Prend en charge la vérification par e-mail (aucun compte nécessaire) ou la connexion avec un compte FreeGuard.

Connexion par e-mail (recommandée) :

# Étape 1 : demander le code de vérification
freeguard login --email [email protected] --send-code

# Étape 2 : saisir le code
freeguard login --email [email protected] --code 123456

✓ Connexion réussie !
✓ 1 abonnement actif trouvé (Pro Plan, expire le 2026-12-01)

Connexion au compte (ouvre le navigateur) :

freeguard login --account

Flags :

Flag	Description
`--email <address>`	Connexion avec vérification par e-mail
`--send-code`	Envoyer le code de vérification par e-mail
`--code <digits>`	Soumettre le code de vérification à 6 chiffres
`--account`	Connexion avec un compte FreeGuard via OAuth dans le navigateur

`freeguard logout`

Effacer les identifiants stockés et se déconnecter si une connexion est active.

freeguard logout

✓ Déconnecté. Identifiants effacés.

Abonnement

`freeguard subscribe list`

Afficher les offres d’abonnement disponibles et l’état actuel de votre abonnement.

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`

Créer un nouvel abonnement. Ouvre votre navigateur pour finaliser le paiement via Stripe ou en cryptomonnaie.

# Sélection interactive de l’offre
freeguard subscribe create

# Spécifier directement l’offre
freeguard subscribe create --plan pro --email [email protected]

Flags :

Flag	Description
`--plan <name>`	Offre d’abonnement (`basic`, `pro`)
`--email <address>`	E-mail pour la livraison de l’abonnement

Configuration

`freeguard config get`

Lire une valeur de configuration.

freeguard config get proxy.port

freeguard config get proxy.port --json

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

`freeguard config set`

Modifier une valeur de configuration.

freeguard config set proxy.port 8080

✓ proxy.port défini sur 8080

Clés de configuration courantes :

Key	Default	Description
`proxy.port`	`7890`	Port du Proxy HTTP/SOCKS5
`proxy.mode`	`rule`	Mode Proxy : `rule`, `global`, `direct`
`core.api_port`	`9090`	Port API de Mihomo
`core.pinned_version`	(empty)	Verrouiller mihomo sur une version spécifique
`dns.provider`	`auto`	Fournisseur DNS
`update.auto_check`	`true`	Vérifier les mises à jour au démarrage

`freeguard config edit`

Ouvrir le fichier de configuration dans votre éditeur par défaut.

freeguard config edit

Diagnostics

`freeguard doctor`

Exécuter une vérification complète de l’environnement pour diagnostiquer les problèmes.

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`

Afficher les informations de version pour le CLI et le moteur principal.

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

Avancé (Phase 2+)

Les commandes suivantes sont prévues pour les futures versions.

`freeguard node list`

Lister les nœuds VPN disponibles avec filtrage et tri.

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

Flags :

Flag	Description
`--country <code>`	Filtrer par code pays
`--protocol <name>`	Filtrer par protocole
`--sort <field>`	Trier par `speed`, `latency` ou `load`

`freeguard node test`

Tester la latence et la vitesse des nœuds.

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

`freeguard monitor`

Afficher la surveillance du trafic en temps réel dans votre terminal.

freeguard monitor

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

`freeguard core`

Gérez le moteur mihomo sous-jacent.

# Check core status
freeguard core status

# Update to latest core version
freeguard core update

# Restart the core engine
freeguard core restart

`freeguard shell`

Entrez en mode REPL interactif pour exécuter plusieurs commandes dans une session.

freeguard shell

`freeguard dashboard`

Ouvrez le tableau de bord TUI avec des graphiques de trafic en temps réel, une liste de nœuds et des détails de connexion.

freeguard dashboard

Dernière mise à jour : March 2026