Referencia de la línea de comandos
En esta página 14 secciones
- Antes de empezar
- Sintaxis
- Resumen rápido
- Autenticación
- --authtoken
- --ephemeral-token
- Gestión del servicio
- Modo headless
- --headless
- --authtoken-file
- --check-config
- El registro headless
- Selección de red
- --network
- --net y --ip
- Proxy de salida
- --proxy
- --proxy-user
- Variables de entorno de proxy
- --http-transport
- Terminal de dispositivos
- --terminal
- --terminal-user
- --pairing-key
- localtonet ssh
- Diagnósticos e información
- --debug
- --version
- --help
- Variables de entorno
- Códigos de salida
- Ejemplos
- Páginas relacionadas
Todas las opciones del cliente de consola localtonet: iniciar sesión con un token, ejecutarlo como servicio, ejecutarlo sin preguntas, elegir una red o un proxy de salida, y los comandos de Terminal de dispositivos.
Antes de empezar #
Esta página trata del cliente de consola para Windows, macOS y Linux, incluido el cliente de la imagen de Docker y de los paquetes de Linux. Instálalo desde la visión general de instalación. Los túneles no se crean en la línea de comandos: los creas, inicias y detienes en el panel, con la API o con el servidor MCP. El cliente conecta un dispositivo a tu cuenta y transporta el tráfico.
Sintaxis #
localtonet [options]
localtonet ssh <DEVICE> [--key <KEY>] [--stdio] [-- <COMMAND>]- Las opciones pueden darse en cualquier orden. Los nombres de las opciones no distinguen mayúsculas de minúsculas, salvo las de
localtonet ssh. - El valor sigue a su opción tras un espacio o un signo igual:
--authtoken <YOUR_TOKEN>y--authtoken=<YOUR_TOKEN>son equivalentes. - Una opción que necesita un valor falla con
<option> requires a value.cuando falta el valor. --proxy,--proxy-usery--http-transportsolo pueden indicarse una vez.- Los marcadores como
<YOUR_TOKEN>representan tus propios valores. Escríbelos sin los corchetes angulares.
Sin opciones, el cliente se inicia de forma interactiva: usa el token guardado o te pide uno, se conecta y muestra una tabla de estado en vivo.
localtonetResumen rápido #
| Opción | Finalidad |
|---|---|
--authtoken <TOKEN> | Inicia sesión con un AuthToken. |
--ephemeral-token | No guarda el token en este dispositivo. |
--install-service, --start-service, --stop-service, --status-service, --remove-service | Gestiona el servicio en segundo plano. |
--headless | Se ejecuta sin preguntas y con líneas de registro simples. |
--authtoken-file <PATH> | Lee el token de un archivo (modo headless). |
--check-config | Comprueba el origen del token y termina (modo headless). |
--network | Muestra las interfaces de red del dispositivo. |
--net <NAME> --ip <ADDRESS> | Envía todo el tráfico del cliente por una interfaz de red. |
--proxy <none|env|URL>, --proxy-user <USER> | Se conecta a Localtonet a través de un proxy de salida. |
--http-transport <auto|https|raw> | Elige cómo se transportan las conexiones con el servidor a través de un proxy. |
--terminal <enable|disable|status>, --terminal-user <ACCOUNT>, --pairing-key <KEY> | Activa o desactiva Terminal de dispositivos en este dispositivo. |
ssh <DEVICE> | Abre una shell o ejecuta un comando en uno de tus dispositivos. |
--debug | Muestra diagnósticos de conexión. |
--version | Muestra la versión. |
--help, -h | Muestra la ayuda integrada. |
Autenticación #
--authtoken #
localtonet --authtoken <YOUR_TOKEN>Inicia sesión en el dispositivo con un AuthToken de Mis tokens. Un token tiene 33 caracteres. El cliente lo guarda en el perfil del usuario actual, así que la próxima vez basta con un simple localtonet.
- Sin
--authtokeny sin un token guardado, el cliente preguntaPlease Enter AuthToken or PIN. Puedes escribir el token o un PIN de seis dígitos que el panel muestra para un token. - Un valor que no es un token válido recibe la respuesta
Wrong Token!y se repite la pregunta. - Mientras el cliente se ejecuta, F12 elimina el token guardado y sale. Ctrl + C sale y lo conserva.
- La grafía antigua sin guiones,
authtoken <YOUR_TOKEN>, todavía se acepta.
Mantén tu token en privado. Permite que el cliente de Localtonet se conecte como este dispositivo. Usa un token por dispositivo: un segundo cliente que se conecte con el mismo token desconecta al primero.
--ephemeral-token #
localtonet --authtoken <YOUR_TOKEN> --ephemeral-tokenUsa el token solo en esta ejecución. El cliente no escribe el token en la configuración guardada ni cambia un token que ya esté guardado. Úsalo para automatización y sesiones temporales.
Gestión del servicio #
Estas opciones registran el cliente en los servicios de Windows, en launchd en macOS o en systemd en Linux. Necesitan derechos de administrador (sudo en macOS y Linux) y cada una requiere el token, porque el servicio lleva su nombre. La guía completa es Ejecutar como servicio.
| Opción | Qué hace | Ejemplo |
|---|---|---|
--install-service | Instala el cliente como un servicio que se inicia con el arranque y lo inicia. Las demás opciones de la línea de comandos se guardan en el servicio. | localtonet --install-service --authtoken <YOUR_TOKEN> |
--start-service | Inicia el servicio instalado. | localtonet --start-service --authtoken <YOUR_TOKEN> |
--stop-service | Detiene el servicio. | localtonet --stop-service --authtoken <YOUR_TOKEN> |
--status-service | Muestra el estado del servicio, por ejemplo Running, Stopped o NotFound. | localtonet --status-service --authtoken <YOUR_TOKEN> |
--remove-service | Detiene el servicio y lo elimina. | localtonet --remove-service --authtoken <YOUR_TOKEN> |
Las opciones de servicio no se usan en el modo headless.
Modo headless #
El modo headless es para contenedores, sistemas de inicio y scripts. El cliente nunca hace preguntas, no reacciona a las teclas, no guarda el token y escribe una línea de registro simple por cada cambio en lugar de la tabla de estado. La imagen de Docker y los paquetes de Linux y OpenWrt ejecutan el cliente de esta forma.
--headless #
localtonet --headless --authtoken-file /etc/localtonet/auth-tokenInicia el cliente en modo headless. Definir la variable de entorno LOCALTONET_HEADLESS=1 tiene el mismo efecto. El cliente se detiene limpiamente cuando recibe una señal de terminación.
El token procede de una de estas fuentes:
| Fuente | Notas |
|---|---|
--authtoken-file <PATH> | Un archivo que contiene solo el token. Se ignoran los espacios y saltos de línea alrededor. |
LOCALTONET_AUTH_TOKEN_FILE | Variable de entorno con la ruta de un archivo así. Se usa cuando no se indica --authtoken-file. |
--authtoken <TOKEN> | El propio token en la línea de comandos. |
LOCALTONET_AUTH_TOKEN | Variable de entorno con el token. Se usa cuando no se indica --authtoken. |
Un archivo de token siempre prevalece sobre un token pasado directamente. Si se indica un archivo de token pero no se puede leer, el cliente se detiene; no recurre a otra fuente.
Cuando no se encuentra ningún token utilizable, el cliente muestra Invalid Localtonet headless configuration. Check the token file or environment settings. y termina con el código 2. Un token utilizable tiene 33 caracteres y no contiene espacios.
--authtoken-file #
localtonet --headless --authtoken-file <PATH>Lee el token de un archivo en lugar de la línea de comandos, para que no aparezca en las listas de procesos ni en el historial de la shell. Protege el archivo, por ejemplo con chmod 600. Esta opción solo se lee en modo headless.
--check-config #
localtonet --headless --authtoken-file /etc/localtonet/auth-token --check-configComprueba el origen del token y termina sin conectarse. Muestra Localtonet headless configuration OK. y termina con el código 0 cuando se encontró un token con formato correcto, y el error anterior con el código 2 en caso contrario. La comprobación es local: no te dice si Localtonet acepta el token. Combínala siempre con --headless (o LOCALTONET_HEADLESS=1); por sí sola se ignora.
El registro headless #
| Línea | Significado |
|---|---|
Localtonet - headless log | El cliente se inició. |
Connection: … | Cambió el estado de la conexión. |
AuthTokenName: … | El nombre del token con el que inició sesión el dispositivo. |
OPEN …, ADDED … | Un túnel que existía al iniciar o que se añadió más tarde. |
STATUS … | Un túnel cambió de estado. |
CLOSED … | Se quitó un túnel de este cliente. |
Authentication failed: AuthToken was rejected. | Localtonet no aceptó el token. |
Cada línea, salvo la primera, empieza con una marca de tiempo. El token nunca se escribe en el registro.
Selección de red #
En un dispositivo con más de una conexión a internet, por ejemplo Ethernet y un módem móvil, puedes elegir cuál usa el cliente. La página Selección de red explica la función y el ajuste por túnel.
--network #
localtonet --networkMuestra todas las interfaces de red activas con sus direcciones, comprueba si cada dirección IPv4 llega a internet y termina. Cada línea ya está escrita como las opciones que pasarías:
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
--------------------------------------------------Las direcciones IPv6 se muestran con IPv6, internet check not available.
--net y --ip #
localtonet --authtoken <YOUR_TOKEN> --net Ethernet --ip 192.168.1.20Fija todo el cliente a una interfaz de red. --net es el nombre de la interfaz y --ip es una dirección de esa interfaz, exactamente como las muestra --network. Ambas deben indicarse juntas. Un nombre de interfaz con espacios puede escribirse tal cual o entre comillas.
- Si el par no se puede aplicar, el cliente espera hasta 30 segundos a que la interfaz se active, lo que ayuda cuando se inicia con el arranque, y después se detiene indicando el motivo y con el código de salida 2. No continúa por otra red.
- Si solo se indica una de las dos opciones, el cliente muestra
--net and --ip must be given together; the default network is used.y continúa sin fijar la red. - En Linux, el cliente añade reglas de enrutamiento para la dirección fijada. Eso requiere root, o
sudosin contraseña para el comandoip.
| Mensaje | Significado |
|---|---|
Network interface '…' was not found. Run 'localtonet --network' to list the interfaces. | El nombre que sigue a --net no coincide con ninguna interfaz. |
Network interface '…' is Down. | La interfaz existe, pero no está activa. |
'…' is not an address of network interface '…'. | La dirección que sigue a --ip no pertenece a esa interfaz. |
'…' is not an IP address. | El valor que sigue a --ip no es una dirección IP. |
Para usar una conexión distinta en un solo túnel en lugar de en todo el cliente, indica el mismo par en el ajuste Argumentos de ese túnel.
Proxy de salida #
Usa estas opciones cuando el dispositivo solo pueda llegar a internet a través de un proxy. Se aplican a las propias conexiones del cliente con Localtonet. No cambian la forma en que el cliente llega a tu servicio local.
--proxy #
| Valor | Qué hace |
|---|---|
No indicado, o none | Se conecta directamente. Las variables de entorno de proxy se ignoran. |
env | Usa las variables de entorno de proxy descritas más abajo. Si no hay ninguna definida, o alguna no es válida, el cliente se detiene con un error en lugar de conectarse directamente. |
| Una URL de proxy | Usa ese proxy para todo. Esquemas admitidos: http://, https://, socks5:// y 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| Esquema | Comportamiento | Puerto predeterminado | Autenticación |
|---|---|---|---|
http:// | Proxy HTTP, mediante CONNECT. | 80 | Ninguna o Basic |
https:// | Primero abre una conexión TLS verificada con el proxy y después usa CONNECT. | 443 | Ninguna o Basic |
socks5:// | SOCKS5, TCP y UDP. Los nombres de host los resuelve tu dispositivo. | 1080 | Ninguna, o nombre de usuario y contraseña |
socks5h:// | SOCKS5, TCP y UDP. Los nombres de host los resuelve el proxy. | 1080 | Ninguna, o nombre de usuario y contraseña |
El host del proxy puede ser una dirección IPv4, un nombre de host o una dirección IPv6 entre corchetes. Las credenciales pueden formar parte de la URL como user:password@host:port; codifica en URL los caracteres especiales que contengan. La salida de depuración nunca incluye credenciales.
--proxy-user #
localtonet --authtoken <YOUR_TOKEN> --proxy socks5h://proxy.example.com:1080 --proxy-user <PROXY_USER>Define el nombre de usuario del proxy y pide la contraseña con un aviso oculto (Proxy password:), para que la contraseña no quede en la línea de comandos. La contraseña no se guarda.
- Necesita
--proxy envo una URL de proxy, y no puede combinarse con credenciales dentro de la URL. - Solo funciona en un terminal interactivo. El modo headless y los servicios nunca preguntan: pon las credenciales en la URL del proxy, o usa
--proxy envcon una URL de proxy que las contenga. --install-servicerechaza--proxy-usery las URL de proxy con contraseña, porque un servicio no puede almacenarlas. Instala el servicio con--proxy envy proporciona las variables en el entorno del servicio.
Variables de entorno de proxy #
Solo se leen con --proxy env. Para cada tipo de conexión se usa la primera variable que esté definida:
| Conexión | Variables, por orden |
|---|---|
| HTTP y WebSocket | http_proxy, HTTP_PROXY, all_proxy, ALL_PROXY |
| HTTPS y WebSocket seguro | https_proxy, HTTPS_PROXY, all_proxy, ALL_PROXY |
| TCP y UDP sin procesar | all_proxy, ALL_PROXY, https_proxy, HTTPS_PROXY, http_proxy, HTTP_PROXY |
no_proxy (o NO_PROXY, si no está definida la de minúsculas) enumera los hosts a los que se llega directamente:
- Las entradas se separan con comas. Un host o dominio coincide consigo mismo y con sus subdominios. La comparación ignora las mayúsculas y un punto inicial.
- Las direcciones IP coinciden exactamente; las direcciones IPv6 pueden ir entre corchetes.
*omite el proxy para todos los hosts. - Los rangos de direcciones (CIDR), las entradas con puerto y los comodines parciales no se admiten y se notifican como error de configuración.
no_proxyno tiene efecto cuando pasas una URL de proxy o te conectas directamente.
--http-transport #
localtonet --authtoken <YOUR_TOKEN> --proxy http://proxy.example.com:3128 --http-transport httpsControla cómo transporta el cliente sus conexiones con el servidor cuando un proxy solo deja pasar tráfico web normal. Con el transporte HTTPS, el cliente envía ese tráfico como solicitudes HTTPS normales a una puerta de enlace de Localtonet en lugar de abrir conexiones sin procesar de larga duración a través del proxy.
| Valor | Qué hace |
|---|---|
auto (predeterminado) | Detrás de un proxy HTTP o HTTPS, el cliente prefiere el transporte HTTPS cuando el servidor lo ofrece y, si no, usa CONNECT. Detrás de un proxy SOCKS5 usa primero TCP y UDP nativos y puede recurrir al transporte HTTPS a través del mismo proxy. |
https | Exige el transporte HTTPS para las conexiones con el servidor. |
raw | Nunca usa el transporte HTTPS: solo CONNECT o SOCKS. |
Cualquier otro valor detiene el cliente con LOCALTONET_HTTP_TRANSPORT_MODE must be auto, https or raw.
Terminal de dispositivos #
Terminal de dispositivos te da una shell en tus propios dispositivos desde el panel o por SSH. Funciona en Windows, Linux y macOS y requiere Localtonet Desktop v8.6 o posterior. La página Terminal de dispositivos describe la función; estas son sus partes de línea de comandos.
--terminal #
localtonet --terminal enable --authtoken <YOUR_TOKEN>
localtonet --terminal status --authtoken <YOUR_TOKEN>
localtonet --terminal disable --authtoken <YOUR_TOKEN>| Valor | Qué hace |
|---|---|
enable | Vincula este dispositivo con tu cuenta. El comando muestra un código de aprobación y espera; abre Mis dispositivos, selecciona Añadir dispositivo e introduce el código. El código es válido durante 15 minutos. Tras la aprobación, el comando muestra Terminal enabled. Shells will run as <account>. |
disable | Desactiva el terminal en este dispositivo y quita el dispositivo de tu cuenta. Si no se puede acceder al panel, el terminal se desactiva igualmente en local y el comando te pide que quites también el dispositivo en el panel. |
status | Muestra si el terminal está activado y con qué cuenta se ejecutan las shells. |
Las tres formas necesitan un token, como un inicio normal: pasa --authtoken o déjalo fuera para usar el token guardado. Si Localtonet se ejecuta como servicio en el dispositivo, ejecuta el comando desde un terminal de administrador o con sudo. En un terminal interactivo, el cliente sigue ejecutándose como un cliente normal tras enable, a menos que Localtonet ya se esté ejecutando en el dispositivo con este token.
--terminal-user #
sudo localtonet --terminal enable --authtoken <YOUR_TOKEN> --terminal-user <ACCOUNT>Elige la cuenta con la que se ejecutan las shells cuando activas el terminal como root o como administrador. Sin esta opción, un enable con privilegios elevados pregunta Run shells as user:; en un script, donde no se puede preguntar, se detiene con Choose the account for shells with --terminal-user. Sin --terminal-user, un comando sin privilegios elevados usa el usuario actual.
--pairing-key #
localtonet --terminal enable --authtoken <YOUR_TOKEN> --terminal-user <ACCOUNT> --pairing-key <PAIRING_KEY>Vincula un dispositivo en el que nadie puede leer un código de aprobación, por ejemplo un servidor que configuras con un script. Crea la clave en Mis dispositivos, en Añadir dispositivo, con Crear clave de un solo uso. Es válida durante una hora y puede usarse una sola vez. Con una clave de vinculación, el comando no muestra un código ni espera la aprobación.
localtonet ssh #
localtonet ssh <DEVICE>
localtonet ssh <DEVICE> -- uptime
localtonet ssh <DEVICE> --key <ACCESS_KEY> -- uptimeAbre una shell en uno de tus dispositivos, o ejecuta allí un comando y devuelve su código de salida. <DEVICE> es el nombre del dispositivo que se muestra en Mis dispositivos. ssh debe ser la primera palabra después de localtonet.
| Parte | Qué hace |
|---|---|
-- <COMMAND> | Ejecuta el comando en lugar de abrir una shell. Todo lo que sigue a -- es el comando. |
--key <ACCESS_KEY> | Una clave de acceso del dispositivo, creada en Claves en Mis dispositivos. Con una clave no se necesita aprobación en el navegador. |
--stdio | No abre una shell. Solo transporta la conexión sin procesar hasta el dispositivo por la entrada y la salida estándar, para usarse como ProxyCommand de un cliente SSH. |
Sin clave, el comando muestra Approve this connection in your browser: seguido de un enlace, y espera hasta cinco minutos a que lo apruebes. Si la conexión no se aprueba, termina con The connection was not approved.
Diagnósticos e información #
--debug #
localtonet --debug --proxy env --authtoken <YOUR_TOKEN>Activa los diagnósticos de conexión en la salida de error estándar: las rutas de proxy en uso y de qué ajuste proceden, el modo DNS, los resultados del handshake y el estado de UDP. Se omiten las credenciales y los cuerpos de las solicitudes. --debug también pone el cliente en modo headless, de modo que no pregunta. Es una opción sin valor.
--version #
localtonet --versionMuestra la versión del cliente, por ejemplo v8.6, y termina.
--help #
localtonet --helpMuestra la ayuda integrada y termina. -h hace lo mismo.
Variables de entorno #
| Variable | Efecto |
|---|---|
LOCALTONET_HEADLESS | 1 activa el modo headless. |
LOCALTONET_AUTH_TOKEN | El token, en modo headless. |
LOCALTONET_AUTH_TOKEN_FILE | Ruta de un archivo de token, en modo headless. |
http_proxy, https_proxy, all_proxy, no_proxy y sus formas en mayúsculas | Ajustes de proxy, solo con --proxy env. |
Códigos de salida #
| Código | Significado |
|---|---|
0 | El comando terminó con normalidad. |
1 | Falló un comando de Terminal de dispositivos, por ejemplo porque el código de aprobación caducó o no se pudo acceder al dispositivo. |
2 | Una opción es incorrecta o le falta el valor, el token headless no es utilizable, o no se pudo aplicar el par --net y --ip. |
localtonet ssh <DEVICE> -- <COMMAND> devuelve el código de salida del comando remoto.
Ejemplos #
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