Référence de la ligne de commande
Sur cette page 14 sections
- Avant de commencer
- Syntaxe
- Aperçu rapide
- Authentification
- --authtoken
- --ephemeral-token
- Gestion du service
- Mode headless
- --headless
- --authtoken-file
- --check-config
- Le journal headless
- Choix du réseau
- --network
- --net et --ip
- Proxy sortant
- --proxy
- --proxy-user
- Variables d'environnement de proxy
- --http-transport
- Terminal d'appareil
- --terminal
- --terminal-user
- --pairing-key
- localtonet ssh
- Diagnostics et informations
- --debug
- --version
- --help
- Variables d'environnement
- Codes de sortie
- Exemples
- Pages associées
Toutes les options du client console localtonet : connexion avec un jeton, exécution en tant que service, exécution sans invite, choix d'un réseau ou d'un proxy sortant, et commandes de Terminal d'appareil.
Avant de commencer #
Cette page couvre le client console pour Windows, macOS et Linux, y compris le client de l'image Docker et des paquets Linux. Installez-le depuis la présentation de l'installation. Les tunnels ne se créent pas en ligne de commande : vous les créez, les démarrez et les arrêtez dans le tableau de bord, avec l'API ou avec le serveur MCP. Le client connecte un appareil à votre compte et transporte le trafic.
Syntaxe #
localtonet [options]
localtonet ssh <DEVICE> [--key <KEY>] [--stdio] [-- <COMMAND>]- Les options peuvent être indiquées dans n'importe quel ordre. Leurs noms ne sont pas sensibles à la casse, sauf pour les options de
localtonet ssh. - Une valeur suit son option après un espace ou un signe égal :
--authtoken <YOUR_TOKEN>et--authtoken=<YOUR_TOKEN>sont équivalents. - Une option qui attend une valeur échoue avec
<option> requires a value.lorsque la valeur est absente. --proxy,--proxy-useret--http-transportne peuvent être indiquées qu'une seule fois.- Les marqueurs tels que
<YOUR_TOKEN>représentent vos propres valeurs. Saisissez-les sans les chevrons.
Sans option, le client démarre en mode interactif : il utilise le jeton enregistré ou en demande un, se connecte et affiche un tableau d'état en direct.
localtonetAperçu rapide #
| Option | Rôle |
|---|---|
--authtoken <TOKEN> | Se connecter avec un AuthToken. |
--ephemeral-token | Ne pas enregistrer le jeton sur cet appareil. |
--install-service, --start-service, --stop-service, --status-service, --remove-service | Gérer le service en arrière-plan. |
--headless | Fonctionner sans invite et avec des lignes de journal simples. |
--authtoken-file <PATH> | Lire le jeton depuis un fichier (mode headless). |
--check-config | Vérifier la source du jeton puis quitter (mode headless). |
--network | Lister les interfaces réseau de l'appareil. |
--net <NAME> --ip <ADDRESS> | Faire passer tout le trafic du client par une seule interface réseau. |
--proxy <none|env|URL>, --proxy-user <USER> | Se connecter à Localtonet via un proxy sortant. |
--http-transport <auto|https|raw> | Choisir comment les connexions au serveur sont transportées à travers un proxy. |
--terminal <enable|disable|status>, --terminal-user <ACCOUNT>, --pairing-key <KEY> | Activer ou désactiver Terminal d'appareil pour cet appareil. |
ssh <DEVICE> | Ouvrir un shell ou exécuter une commande sur l'un de vos appareils. |
--debug | Afficher les diagnostics de connexion. |
--version | Afficher la version. |
--help, -h | Afficher l'aide intégrée. |
Authentification #
--authtoken #
localtonet --authtoken <YOUR_TOKEN>Connecte l'appareil avec un AuthToken provenant de Mes jetons. Un jeton compte 33 caractères. Le client l'enregistre dans le profil de l'utilisateur courant ; la fois suivante, un simple localtonet suffit.
- Sans
--authtokenet sans jeton enregistré, le client demandePlease Enter AuthToken or PIN. Vous pouvez saisir le jeton ou un code PIN à six chiffres affiché par le tableau de bord pour un jeton. - Une valeur qui n'est pas un jeton valide reçoit la réponse
Wrong Token!, puis la question est reposée. - Pendant l'exécution du client, F12 supprime le jeton enregistré et quitte. Ctrl + C quitte en le conservant.
- L'ancienne écriture sans tirets,
authtoken <YOUR_TOKEN>, est toujours acceptée.
Gardez votre jeton confidentiel. Il permet au client Localtonet de se connecter en tant que cet appareil. Utilisez un jeton par appareil : un second client qui se connecte avec le même jeton déconnecte le premier.
--ephemeral-token #
localtonet --authtoken <YOUR_TOKEN> --ephemeral-tokenUtilise le jeton pour cette exécution uniquement. Le client n'écrit pas le jeton dans les paramètres enregistrés et ne modifie pas un jeton déjà enregistré. À utiliser pour l'automatisation et les sessions temporaires.
Gestion du service #
Ces options enregistrent le client auprès des services Windows, de launchd sur macOS ou de systemd sur Linux. Elles exigent des droits d'administrateur (sudo sur macOS et Linux), et chacune a besoin du jeton, car le service porte son nom. Le guide complet est Exécuter en tant que service.
| Option | Fonction | Exemple |
|---|---|---|
--install-service | Installe le client en tant que service qui démarre au boot, puis le démarre. Les autres options de la ligne de commande sont stockées dans le service. | localtonet --install-service --authtoken <YOUR_TOKEN> |
--start-service | Démarre le service installé. | localtonet --start-service --authtoken <YOUR_TOKEN> |
--stop-service | Arrête le service. | localtonet --stop-service --authtoken <YOUR_TOKEN> |
--status-service | Affiche l'état du service, par exemple Running, Stopped ou NotFound. | localtonet --status-service --authtoken <YOUR_TOKEN> |
--remove-service | Arrête le service et le supprime. | localtonet --remove-service --authtoken <YOUR_TOKEN> |
Les options de service ne sont pas utilisées en mode headless.
Mode headless #
Le mode headless est destiné aux conteneurs, aux systèmes d'init et aux scripts. Le client ne pose jamais de question, ne réagit pas aux touches, n'enregistre pas le jeton et écrit une ligne de journal simple par changement au lieu du tableau d'état. L'image Docker et les paquets Linux et OpenWrt exécutent le client de cette façon.
--headless #
localtonet --headless --authtoken-file /etc/localtonet/auth-tokenDémarre le client en mode headless. Définir la variable d'environnement LOCALTONET_HEADLESS=1 a le même effet. Le client s'arrête proprement lorsqu'il reçoit un signal de terminaison.
Le jeton provient de l'une de ces sources :
| Source | Remarques |
|---|---|
--authtoken-file <PATH> | Un fichier qui contient uniquement le jeton. Les espaces et sauts de ligne autour sont ignorés. |
LOCALTONET_AUTH_TOKEN_FILE | Variable d'environnement contenant le chemin d'un tel fichier. Utilisée lorsque --authtoken-file n'est pas indiqué. |
--authtoken <TOKEN> | Le jeton lui-même sur la ligne de commande. |
LOCALTONET_AUTH_TOKEN | Variable d'environnement contenant le jeton. Utilisée lorsque --authtoken n'est pas indiqué. |
Un fichier de jeton l'emporte toujours sur un jeton transmis directement. Si un fichier de jeton est indiqué mais ne peut pas être lu, le client s'arrête ; il ne se rabat pas sur une autre source.
Lorsqu'aucun jeton utilisable n'est trouvé, le client affiche Invalid Localtonet headless configuration. Check the token file or environment settings. et quitte avec le code 2. Un jeton utilisable compte 33 caractères et ne contient aucun espace.
--authtoken-file #
localtonet --headless --authtoken-file <PATH>Lit le jeton depuis un fichier plutôt que sur la ligne de commande, afin qu'il n'apparaisse ni dans la liste des processus ni dans l'historique du shell. Protégez le fichier, par exemple avec chmod 600. Cette option n'est lue qu'en mode headless.
--check-config #
localtonet --headless --authtoken-file /etc/localtonet/auth-token --check-configVérifie la source du jeton et quitte sans se connecter. Il affiche Localtonet headless configuration OK. et quitte avec le code 0 lorsqu'un jeton bien formé a été trouvé, et l'erreur ci-dessus avec le code 2 dans le cas contraire. La vérification est locale : elle ne vous dit pas si Localtonet accepte le jeton. Combinez-la toujours avec --headless (ou LOCALTONET_HEADLESS=1) ; seule, elle est ignorée.
Le journal headless #
| Ligne | Signification |
|---|---|
Localtonet - headless log | Le client a démarré. |
Connection: … | L'état de la connexion a changé. |
AuthTokenName: … | Le nom du jeton avec lequel l'appareil s'est connecté. |
OPEN …, ADDED … | Un tunnel qui existait au démarrage ou qui a été ajouté plus tard. |
STATUS … | Un tunnel a changé d'état. |
CLOSED … | Un tunnel a été retiré de ce client. |
Authentication failed: AuthToken was rejected. | Localtonet n'a pas accepté le jeton. |
Chaque ligne après la première commence par un horodatage. Le jeton n'est jamais écrit dans le journal.
Choix du réseau #
Sur un appareil disposant de plusieurs connexions internet, par exemple Ethernet et un modem mobile, vous pouvez choisir celle qu'utilise le client. La page Choix du réseau explique cette fonction et le paramètre par tunnel.
--network #
localtonet --networkListe chaque interface réseau active avec ses adresses, vérifie si chaque adresse IPv4 accède à internet, puis quitte. Chaque ligne est déjà écrite sous la forme des options à transmettre :
NetworkName: Ethernet
--net Ethernet --ip 192.168.1.20 --> Internet available (public IP 203.0.113.10)
--------------------------------------------------
NetworkName: Mobile
--net Mobile --ip 10.20.30.40 --> No internet access
--------------------------------------------------Les adresses IPv6 sont listées avec IPv6, internet check not available.
--net et --ip #
localtonet --authtoken <YOUR_TOKEN> --net Ethernet --ip 192.168.1.20Épingle tout le client à une seule interface réseau. --net est le nom de l'interface et --ip une adresse de cette interface, exactement comme --network les affiche. Les deux doivent être indiquées ensemble. Un nom d'interface contenant des espaces peut être écrit tel quel ou entre guillemets.
- Si la paire ne peut pas être appliquée, le client attend jusqu'à 30 secondes que l'interface soit active, ce qui aide lorsqu'il démarre au boot, puis s'arrête en indiquant la raison avec le code de sortie 2. Il ne continue pas sur un autre réseau.
- Si une seule des deux options est indiquée, le client affiche
--net and --ip must be given together; the default network is used.et continue sans épinglage. - Sous Linux, le client ajoute des règles de routage pour l'adresse épinglée. Cela exige root, ou
sudosans mot de passe pour la commandeip.
| Message | Signification |
|---|---|
Network interface '…' was not found. Run 'localtonet --network' to list the interfaces. | Le nom après --net ne correspond à aucune interface. |
Network interface '…' is Down. | L'interface existe mais n'est pas active. |
'…' is not an address of network interface '…'. | L'adresse après --ip n'appartient pas à cette interface. |
'…' is not an IP address. | La valeur après --ip n'est pas une adresse IP. |
Pour utiliser une autre connexion pour un seul tunnel plutôt que pour tout le client, définissez la même paire dans le paramètre Arguments de ce tunnel.
Proxy sortant #
Utilisez ces options lorsque l'appareil ne peut accéder à internet que par un proxy. Elles s'appliquent aux propres connexions du client vers Localtonet. Elles ne changent pas la façon dont le client atteint votre service local.
--proxy #
| Valeur | Fonction |
|---|---|
Absente, ou none | Se connecte directement. Les variables d'environnement de proxy sont ignorées. |
env | Utilise les variables d'environnement de proxy décrites ci-dessous. Si aucune n'est définie, ou si l'une est invalide, le client s'arrête avec une erreur au lieu de se connecter directement. |
| Une URL de proxy | Utilise ce proxy pour tout. Schémas pris en charge : http://, https://, socks5:// et socks5h://. |
localtonet --authtoken <YOUR_TOKEN> --proxy http://proxy.example.com:3128
localtonet --authtoken <YOUR_TOKEN> --proxy socks5h://proxy.example.com:1080
localtonet --authtoken <YOUR_TOKEN> --proxy env| Schéma | Comportement | Port par défaut | Authentification |
|---|---|---|---|
http:// | Proxy HTTP, avec CONNECT. | 80 | Aucune ou Basic |
https:// | Ouvre d'abord une connexion TLS vérifiée vers le proxy, puis utilise CONNECT. | 443 | Aucune ou Basic |
socks5:// | SOCKS5, TCP et UDP. Les noms d'hôte sont résolus sur votre appareil. | 1080 | Aucune, ou nom d'utilisateur et mot de passe |
socks5h:// | SOCKS5, TCP et UDP. Les noms d'hôte sont résolus par le proxy. | 1080 | Aucune, ou nom d'utilisateur et mot de passe |
L'hôte du proxy peut être une adresse IPv4, un nom d'hôte ou une adresse IPv6 entre crochets. Les identifiants peuvent faire partie de l'URL sous la forme user:password@host:port ; encodez en URL les caractères spéciaux qu'ils contiennent. La sortie de débogage n'inclut jamais les identifiants.
--proxy-user #
localtonet --authtoken <YOUR_TOKEN> --proxy socks5h://proxy.example.com:1080 --proxy-user <PROXY_USER>Définit le nom d'utilisateur du proxy et demande le mot de passe par une invite masquée (Proxy password:), afin que le mot de passe ne figure pas sur la ligne de commande. Le mot de passe n'est pas enregistré.
- Elle nécessite
--proxy envou une URL de proxy, et ne peut pas être combinée avec des identifiants dans l'URL. - Elle ne fonctionne que dans un terminal interactif. Le mode headless et les services n'affichent jamais d'invite : placez les identifiants dans l'URL du proxy, ou utilisez
--proxy envavec une URL de proxy qui les contient. --install-servicerefuse--proxy-useret les URL de proxy contenant un mot de passe, car un service ne peut pas les stocker. Installez le service avec--proxy envet fournissez les variables dans l'environnement du service.
Variables d'environnement de proxy #
Elles ne sont lues qu'avec --proxy env. Pour chaque type de connexion, la première variable définie est utilisée :
| Connexion | Variables, dans l'ordre |
|---|---|
| HTTP et WebSocket | http_proxy, HTTP_PROXY, all_proxy, ALL_PROXY |
| HTTPS et WebSocket sécurisé | https_proxy, HTTPS_PROXY, all_proxy, ALL_PROXY |
| TCP brut et UDP | all_proxy, ALL_PROXY, https_proxy, HTTPS_PROXY, http_proxy, HTTP_PROXY |
no_proxy (ou NO_PROXY, si la variable en minuscules n'est pas définie) liste les hôtes joints directement :
- Les entrées sont séparées par des virgules. Un hôte ou un domaine correspond à lui-même et à ses sous-domaines. La correspondance ignore la casse et un point initial.
- Les adresses IP correspondent exactement ; les adresses IPv6 peuvent être entre crochets.
*contourne le proxy pour tous les hôtes. - Les plages d'adresses (CIDR), les entrées avec un port et les jokers partiels ne sont pas pris en charge et sont signalés comme une erreur de configuration.
no_proxyn'a aucun effet lorsque vous transmettez une URL de proxy ou vous connectez directement.
--http-transport #
localtonet --authtoken <YOUR_TOKEN> --proxy http://proxy.example.com:3128 --http-transport httpsContrôle la façon dont le client transporte ses connexions au serveur lorsqu'un proxy ne laisse passer que le trafic web ordinaire. Avec le transport HTTPS, le client envoie ce trafic sous forme de requêtes HTTPS normales à une passerelle Localtonet au lieu d'ouvrir des connexions brutes de longue durée à travers le proxy.
| Valeur | Fonction |
|---|---|
auto (par défaut) | Derrière un proxy HTTP ou HTTPS, le client privilégie le transport HTTPS lorsque le serveur le propose, et utilise sinon CONNECT. Derrière un proxy SOCKS5, il utilise d'abord TCP et UDP natifs et peut se rabattre sur le transport HTTPS via le même proxy. |
https | Exige le transport HTTPS pour les connexions au serveur. |
raw | N'utilise jamais le transport HTTPS : uniquement CONNECT ou SOCKS. |
Toute autre valeur arrête le client avec LOCALTONET_HTTP_TRANSPORT_MODE must be auto, https or raw.
Terminal d'appareil #
Terminal d'appareil vous donne un shell sur vos propres appareils depuis le tableau de bord ou via SSH. Il fonctionne sous Windows, Linux et macOS et nécessite Localtonet Desktop v8.6 ou ultérieur. La page Terminal d'appareil décrit la fonction ; voici ses parties en ligne de commande.
--terminal #
localtonet --terminal enable --authtoken <YOUR_TOKEN>
localtonet --terminal status --authtoken <YOUR_TOKEN>
localtonet --terminal disable --authtoken <YOUR_TOKEN>| Valeur | Fonction |
|---|---|
enable | Associe cet appareil à votre compte. La commande affiche un code d'approbation et attend ; ouvrez Mes appareils, sélectionnez Ajouter un appareil et saisissez le code. Le code est valable 15 minutes. Après approbation, la commande affiche Terminal enabled. Shells will run as <account>. |
disable | Désactive le terminal sur cet appareil et retire l'appareil de votre compte. Si le tableau de bord est inaccessible, le terminal est tout de même désactivé localement et la commande vous demande de retirer aussi l'appareil dans le tableau de bord. |
status | Affiche si le terminal est activé et sous quel compte s'exécutent les shells. |
Les trois formes ont besoin d'un jeton, comme un démarrage normal : transmettez --authtoken, ou omettez-le pour utiliser le jeton enregistré. Si Localtonet s'exécute en tant que service sur l'appareil, lancez la commande depuis un terminal Administrateur ou avec sudo. Dans un terminal interactif, le client continue de s'exécuter comme un client normal après enable, sauf si Localtonet s'exécute déjà sur l'appareil avec ce jeton.
--terminal-user #
sudo localtonet --terminal enable --authtoken <YOUR_TOKEN> --terminal-user <ACCOUNT>Choisit le compte sous lequel s'exécutent les shells, lorsque vous activez le terminal en tant que root ou administrateur. Sans elle, un enable avec élévation demande Run shells as user: ; dans un script, où rien ne peut être demandé, il s'arrête avec Choose the account for shells with --terminal-user. Sans --terminal-user, une commande sans élévation utilise l'utilisateur courant.
--pairing-key #
localtonet --terminal enable --authtoken <YOUR_TOKEN> --terminal-user <ACCOUNT> --pairing-key <PAIRING_KEY>Associe un appareil sur lequel personne ne peut lire un code d'approbation, par exemple un serveur configuré par un script. Créez la clé dans Mes appareils sous Ajouter un appareil avec Créer une clé à usage unique. Elle est valable une heure et ne peut servir qu'une fois. Avec une clé d'association, la commande n'affiche pas de code et n'attend pas d'approbation.
localtonet ssh #
localtonet ssh <DEVICE>
localtonet ssh <DEVICE> -- uptime
localtonet ssh <DEVICE> --key <ACCESS_KEY> -- uptimeOuvre un shell sur l'un de vos appareils, ou y exécute une commande et renvoie son code de sortie. <DEVICE> est le nom de l'appareil affiché dans Mes appareils. ssh doit être le premier mot après localtonet.
| Élément | Fonction |
|---|---|
-- <COMMAND> | Exécute la commande au lieu d'ouvrir un shell. Tout ce qui suit -- est la commande. |
--key <ACCESS_KEY> | Une clé d'accès de l'appareil, créée sous Clés dans Mes appareils. Avec une clé, aucune approbation dans le navigateur n'est nécessaire. |
--stdio | N'ouvre pas de shell. Transporte seulement la connexion brute vers l'appareil via l'entrée et la sortie standard, pour servir de ProxyCommand à un client SSH. |
Sans clé, la commande affiche Approve this connection in your browser: suivi d'un lien, et attend jusqu'à cinq minutes que vous approuviez. Si la connexion n'est pas approuvée, elle se termine par The connection was not approved.
Diagnostics et informations #
--debug #
localtonet --debug --proxy env --authtoken <YOUR_TOKEN>Active les diagnostics de connexion sur la sortie d'erreur standard : les routes de proxy utilisées et le paramètre dont elles proviennent, le mode DNS, les résultats de la poignée de main et l'état UDP. Les identifiants et les corps de requête sont omis. --debug passe aussi le client en mode headless, il n'affiche donc pas d'invite. C'est un indicateur qui ne prend pas de valeur.
--version #
localtonet --versionAffiche la version du client, par exemple v8.6, puis quitte.
--help #
localtonet --helpAffiche l'aide intégrée puis quitte. -h fait la même chose.
Variables d'environnement #
| Variable | Effet |
|---|---|
LOCALTONET_HEADLESS | 1 active le mode headless. |
LOCALTONET_AUTH_TOKEN | Le jeton, en mode headless. |
LOCALTONET_AUTH_TOKEN_FILE | Chemin d'un fichier de jeton, en mode headless. |
http_proxy, https_proxy, all_proxy, no_proxy et leurs formes en majuscules | Paramètres de proxy, uniquement avec --proxy env. |
Codes de sortie #
| Code | Signification |
|---|---|
0 | La commande s'est terminée normalement. |
1 | Une commande Terminal d'appareil a échoué, par exemple parce que le code d'approbation a expiré ou que l'appareil est injoignable. |
2 | Une option est incorrecte ou n'a pas sa valeur, le jeton headless est inutilisable, ou la paire --net et --ip n'a pas pu être appliquée. |
localtonet ssh <DEVICE> -- <COMMAND> renvoie le code de sortie de la commande distante.
Exemples #
localtonet --authtoken <YOUR_TOKEN>sudo localtonet --install-service --authtoken <YOUR_TOKEN>
sudo localtonet --status-service --authtoken <YOUR_TOKEN>docker run -d --restart unless-stopped -e LOCALTONET_AUTH_TOKEN=<YOUR_TOKEN> localtonet/localtonetlocaltonet --network
localtonet --authtoken <YOUR_TOKEN> --net Mobile --ip 10.20.30.40export all_proxy=http://proxy.example.com:3128
localtonet --authtoken <YOUR_TOKEN> --proxy env