Справочник по командной строке
На этой странице 14 разделов
- Перед началом
- Синтаксис
- Краткий обзор
- Аутентификация
- --authtoken
- --ephemeral-token
- Управление службой
- Режим headless
- --headless
- --authtoken-file
- --check-config
- Журнал headless
- Выбор сети
- --network
- --net и --ip
- Исходящий прокси
- --proxy
- --proxy-user
- Переменные окружения прокси
- --http-transport
- Терминал устройств
- --terminal
- --terminal-user
- --pairing-key
- localtonet ssh
- Диагностика и сведения
- --debug
- --version
- --help
- Переменные окружения
- Коды завершения
- Примеры
- Связанные страницы
Все параметры консольного клиента localtonet: вход по токену, запуск в виде службы, запуск без запросов, выбор сети или исходящего прокси и команды Терминала устройств.
Перед началом #
Эта страница посвящена консольному клиенту для Windows, macOS и Linux, включая клиент в образе Docker и в пакетах для Linux. Установите его по обзору установки. Туннели не создаются в командной строке: вы создаёте, запускаете и останавливаете их в панели управления, через API или через MCP-сервер. Клиент подключает устройство к вашему аккаунту и передаёт трафик.
Синтаксис #
localtonet [options]
localtonet ssh <DEVICE> [--key <KEY>] [--stdio] [-- <COMMAND>]- Параметры можно указывать в любом порядке. Регистр в названиях параметров не учитывается, кроме параметров
localtonet ssh. - Значение указывается после параметра через пробел или знак равенства:
--authtoken <YOUR_TOKEN>и--authtoken=<YOUR_TOKEN>равнозначны. - Если параметру нужно значение, а оно не указано, команда завершается ошибкой
<option> requires a value. --proxy,--proxy-userи--http-transportможно указать только один раз.- Заполнители вроде
<YOUR_TOKEN>обозначают ваши собственные значения. Вводите их без угловых скобок.
Без параметров клиент запускается в интерактивном режиме: он использует сохранённый токен или запрашивает его, подключается и показывает таблицу состояния в реальном времени.
localtonetКраткий обзор #
| Параметр | Назначение |
|---|---|
--authtoken <TOKEN> | Вход с помощью AuthToken. |
--ephemeral-token | Не сохранять токен на этом устройстве. |
--install-service, --start-service, --stop-service, --status-service, --remove-service | Управление фоновой службой. |
--headless | Запуск без запросов, с простыми строками журнала. |
--authtoken-file <PATH> | Чтение токена из файла (режим headless). |
--check-config | Проверка источника токена и выход (режим headless). |
--network | Список сетевых интерфейсов устройства. |
--net <NAME> --ip <ADDRESS> | Направить весь трафик клиента через один сетевой интерфейс. |
--proxy <none|env|URL>, --proxy-user <USER> | Подключение к Localtonet через исходящий прокси. |
--http-transport <auto|https|raw> | Выбор способа передачи соединений с серверами через прокси. |
--terminal <enable|disable|status>, --terminal-user <ACCOUNT>, --pairing-key <KEY> | Включить или выключить Терминал устройств на этом устройстве. |
ssh <DEVICE> | Открыть оболочку или выполнить команду на одном из ваших устройств. |
--debug | Вывод диагностики соединений. |
--version | Вывод версии. |
--help, -h | Вывод встроенной справки. |
Аутентификация #
--authtoken #
localtonet --authtoken <YOUR_TOKEN>Выполняет вход устройства с помощью AuthToken из раздела Мои токены. Длина токена — 33 символа. Клиент сохраняет его в профиле текущего пользователя, поэтому в следующий раз достаточно просто localtonet.
- Без
--authtokenи без сохранённого токена клиент спрашиваетPlease Enter AuthToken or PIN. Вы можете ввести токен или шестизначный PIN-код, который панель управления показывает для токена. - Если значение не является допустимым токеном, клиент отвечает
Wrong Token!и задаёт вопрос снова. - Пока клиент работает, F12 удаляет сохранённый токен и завершает работу. Ctrl + C завершает работу и сохраняет токен.
- Старая запись без дефисов,
authtoken <YOUR_TOKEN>, по-прежнему принимается.
Храните токен в тайне. Он позволяет клиенту Localtonet подключаться от имени этого устройства. Используйте один токен на устройство: второй клиент, подключившийся с тем же токеном, отключает первый.
--ephemeral-token #
localtonet --authtoken <YOUR_TOKEN> --ephemeral-tokenИспользует токен только для этого запуска. Клиент не записывает токен в сохранённые настройки и не меняет уже сохранённый токен. Подходит для автоматизации и временных сеансов.
Управление службой #
Эти параметры регистрируют клиент в службах Windows, в launchd на macOS или в systemd на Linux. Для них нужны права администратора (sudo на macOS и Linux), и каждому нужен токен, потому что служба называется по нему. Полное руководство — Запуск в виде службы.
| Параметр | Что делает | Пример |
|---|---|---|
--install-service | Устанавливает клиент как службу, которая запускается при загрузке, и запускает её. Остальные параметры командной строки сохраняются в службе. | localtonet --install-service --authtoken <YOUR_TOKEN> |
--start-service | Запускает установленную службу. | localtonet --start-service --authtoken <YOUR_TOKEN> |
--stop-service | Останавливает службу. | localtonet --stop-service --authtoken <YOUR_TOKEN> |
--status-service | Выводит состояние службы, например Running, Stopped или NotFound. | localtonet --status-service --authtoken <YOUR_TOKEN> |
--remove-service | Останавливает службу и удаляет её. | localtonet --remove-service --authtoken <YOUR_TOKEN> |
Параметры службы не используются в режиме headless.
Режим headless #
Режим headless предназначен для контейнеров, систем инициализации и скриптов. Клиент никогда не задаёт вопросов, не реагирует на клавиши, не сохраняет токен и вместо таблицы состояния пишет по одной простой строке журнала на каждое изменение. Образ Docker и пакеты для Linux и OpenWrt запускают клиент именно так.
--headless #
localtonet --headless --authtoken-file /etc/localtonet/auth-tokenЗапускает клиент в режиме headless. Тот же эффект даёт переменная окружения LOCALTONET_HEADLESS=1. Клиент корректно завершает работу, получив сигнал завершения.
Токен берётся из одного из этих источников:
| Источник | Примечания |
|---|---|
--authtoken-file <PATH> | Файл, содержащий только токен. Пробелы и переводы строк вокруг него игнорируются. |
LOCALTONET_AUTH_TOKEN_FILE | Переменная окружения с путём к такому файлу. Используется, если не указан --authtoken-file. |
--authtoken <TOKEN> | Сам токен в командной строке. |
LOCALTONET_AUTH_TOKEN | Переменная окружения с токеном. Используется, если не указан --authtoken. |
Файл с токеном всегда имеет приоритет над токеном, переданным напрямую. Если файл с токеном указан, но его не удаётся прочитать, клиент останавливается и не переходит к другому источнику.
Если пригодный токен не найден, клиент выводит Invalid Localtonet headless configuration. Check the token file or environment settings. и завершается с кодом 2. Пригодный токен имеет длину 33 символа и не содержит пробелов.
--authtoken-file #
localtonet --headless --authtoken-file <PATH>Читает токен из файла, а не из командной строки, чтобы он не попадал в списки процессов и историю оболочки. Защитите файл, например с помощью chmod 600. Этот параметр читается только в режиме headless.
--check-config #
localtonet --headless --authtoken-file /etc/localtonet/auth-token --check-configПроверяет источник токена и завершается без подключения. Если найден токен правильного формата, выводит Localtonet headless configuration OK. и завершается с кодом 0, иначе выводит указанную выше ошибку и завершается с кодом 2. Проверка локальная: она не говорит, принимает ли Localtonet этот токен. Всегда используйте её вместе с --headless (или LOCALTONET_HEADLESS=1); сама по себе она игнорируется.
Журнал headless #
| Строка | Значение |
|---|---|
Localtonet - headless log | Клиент запущен. |
Connection: … | Изменилось состояние соединения. |
AuthTokenName: … | Имя токена, с которым устройство выполнило вход. |
OPEN …, ADDED … | Туннель, существовавший при запуске или добавленный позже. |
STATUS … | У туннеля изменился статус. |
CLOSED … | Туннель удалён из этого клиента. |
Authentication failed: AuthToken was rejected. | Localtonet не принял токен. |
Каждая строка, кроме первой, начинается с метки времени. Токен никогда не записывается в журнал.
Выбор сети #
На устройстве с несколькими подключениями к интернету, например Ethernet и мобильным модемом, можно выбрать, какое из них использует клиент. Эта возможность и настройка для отдельного туннеля описаны на странице Выбор сети.
--network #
localtonet --networkВыводит все активные сетевые интерфейсы с их адресами, проверяет, выходит ли каждый адрес IPv4 в интернет, и завершается. Каждая строка уже записана в виде параметров, которые вы передадите:
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
--------------------------------------------------Адреса IPv6 выводятся с пометкой IPv6, internet check not available.
--net и --ip #
localtonet --authtoken <YOUR_TOKEN> --net Ethernet --ip 192.168.1.20Привязывает весь клиент к одному сетевому интерфейсу. --net — имя интерфейса, а --ip — адрес этого интерфейса, в точности как их выводит --network. Оба параметра нужно указывать вместе. Имя интерфейса с пробелами можно писать как есть или в кавычках.
- Если пару не удаётся применить, клиент ждёт до 30 секунд, пока интерфейс поднимется (это помогает при запуске во время загрузки), а затем останавливается, указывая причину, с кодом 2. На другую сеть он не переключается.
- Если указан только один из двух параметров, клиент выводит
--net and --ip must be given together; the default network is used.и продолжает работу без привязки. - В Linux клиент добавляет правила маршрутизации для закреплённого адреса. Для этого нужен root или
sudoбез пароля для командыip.
| Сообщение | Значение |
|---|---|
Network interface '…' was not found. Run 'localtonet --network' to list the interfaces. | Имя после --net не соответствует ни одному интерфейсу. |
Network interface '…' is Down. | Интерфейс существует, но не активен. |
'…' is not an address of network interface '…'. | Адрес после --ip не принадлежит этому интерфейсу. |
'…' is not an IP address. | Значение после --ip не является IP-адресом. |
Чтобы использовать другое подключение только для одного туннеля, а не для всего клиента, укажите ту же пару в настройке Аргументы этого туннеля.
Исходящий прокси #
Используйте эти параметры, если устройство выходит в интернет только через прокси. Они относятся к собственным подключениям клиента к Localtonet и не меняют то, как клиент обращается к вашему локальному сервису.
--proxy #
| Значение | Что делает |
|---|---|
Не указан или none | Подключается напрямую. Переменные окружения прокси игнорируются. |
env | Использует переменные окружения прокси, описанные ниже. Если не задана ни одна из них или значение недопустимо, клиент останавливается с ошибкой, а не подключается напрямую. |
| URL прокси | Использует этот прокси для всего. Поддерживаемые схемы: http://, https://, socks5:// и 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| Схема | Поведение | Порт по умолчанию | Аутентификация |
|---|---|---|---|
http:// | HTTP-прокси, с использованием CONNECT. | 80 | Без аутентификации или Basic |
https:// | Сначала открывает проверенное TLS-соединение с прокси, затем использует CONNECT. | 443 | Без аутентификации или Basic |
socks5:// | SOCKS5, TCP и UDP. Имена хостов разрешаются на вашем устройстве. | 1080 | Без аутентификации или имя пользователя и пароль |
socks5h:// | SOCKS5, TCP и UDP. Имена хостов разрешает прокси. | 1080 | Без аутентификации или имя пользователя и пароль |
Хост прокси может быть адресом IPv4, именем хоста или адресом IPv6 в квадратных скобках. Учётные данные можно включить в URL в виде user:password@host:port; специальные символы в них нужно закодировать как в URL. Отладочный вывод никогда не содержит учётных данных.
--proxy-user #
localtonet --authtoken <YOUR_TOKEN> --proxy socks5h://proxy.example.com:1080 --proxy-user <PROXY_USER>Задаёт имя пользователя прокси и запрашивает пароль через скрытый ввод (Proxy password:), чтобы пароль не попадал в командную строку. Пароль не сохраняется.
- Для него нужен
--proxy envили URL прокси; его нельзя сочетать с учётными данными внутри URL. - Он работает только в интерактивном терминале. Режим headless и службы никогда ничего не запрашивают: укажите учётные данные в URL прокси или используйте
--proxy envс URL прокси, который их содержит. --install-serviceотклоняет--proxy-userи URL прокси с паролем, потому что служба не может их хранить. Установите службу с--proxy envи задайте переменные в окружении службы.
Переменные окружения прокси #
Они читаются только при --proxy env. Для каждого вида соединения используется первая заданная переменная:
| Соединение | Переменные по порядку |
|---|---|
| HTTP и WebSocket | http_proxy, HTTP_PROXY, all_proxy, ALL_PROXY |
| HTTPS и защищённый WebSocket | https_proxy, HTTPS_PROXY, all_proxy, ALL_PROXY |
| Необработанные TCP и UDP | all_proxy, ALL_PROXY, https_proxy, HTTPS_PROXY, http_proxy, HTTP_PROXY |
no_proxy (или NO_PROXY, если версия в нижнем регистре не задана) перечисляет хосты, к которым подключаются напрямую:
- Записи разделяются запятыми. Хост или домен соответствует самому себе и своим поддоменам. При сопоставлении регистр и начальная точка игнорируются.
- IP-адреса сопоставляются точно; адреса IPv6 могут быть в квадратных скобках.
*отключает прокси для всех хостов. - Диапазоны адресов (CIDR), записи с портом и частичные подстановочные знаки не поддерживаются и считаются ошибкой конфигурации.
no_proxyне действует, если вы передаёте URL прокси или подключаетесь напрямую.
--http-transport #
localtonet --authtoken <YOUR_TOKEN> --proxy http://proxy.example.com:3128 --http-transport httpsОпределяет, как клиент передаёт соединения с серверами, когда прокси пропускает только обычный веб-трафик. При транспорте HTTPS клиент отправляет этот трафик как обычные HTTPS-запросы на шлюз Localtonet, а не открывает через прокси долгоживущие необработанные соединения.
| Значение | Что делает |
|---|---|
auto (по умолчанию) | За HTTP- или HTTPS-прокси клиент предпочитает транспорт HTTPS, если сервер его предлагает, а иначе использует CONNECT. За прокси SOCKS5 он сначала использует нативные TCP и UDP и может перейти на транспорт HTTPS через тот же прокси. |
https | Требует транспорт HTTPS для соединений с серверами. |
raw | Никогда не использует транспорт HTTPS: только CONNECT или SOCKS. |
Любое другое значение останавливает клиент с сообщением LOCALTONET_HTTP_TRANSPORT_MODE must be auto, https or raw.
Терминал устройств #
Терминал устройств даёт вам оболочку на ваших устройствах из панели управления или по SSH. Он работает в Windows, Linux и macOS и требует Localtonet Desktop v8.6 или новее. Саму возможность описывает страница Терминал устройств; здесь собраны её команды для командной строки.
--terminal #
localtonet --terminal enable --authtoken <YOUR_TOKEN>
localtonet --terminal status --authtoken <YOUR_TOKEN>
localtonet --terminal disable --authtoken <YOUR_TOKEN>| Значение | Что делает |
|---|---|
enable | Привязывает это устройство к вашему аккаунту. Команда выводит код подтверждения и ждёт; откройте Мои устройства, выберите Добавить устройство и введите код. Код действует 15 минут. После подтверждения команда выводит Terminal enabled. Shells will run as <account>. |
disable | Отключает терминал на этом устройстве и удаляет устройство из вашего аккаунта. Если панель управления недоступна, терминал всё равно отключается локально, и команда просит также удалить устройство в панели управления. |
status | Выводит, включён ли терминал и от имени какой учётной записи запускаются оболочки. |
Всем трём формам нужен токен, как при обычном запуске: передайте --authtoken или опустите его, чтобы использовать сохранённый токен. Если Localtonet работает на устройстве как служба, выполните команду в терминале администратора или с sudo. В интерактивном терминале клиент после enable продолжает работать как обычный клиент, если только Localtonet уже не запущен на устройстве с этим токеном.
--terminal-user #
sudo localtonet --terminal enable --authtoken <YOUR_TOKEN> --terminal-user <ACCOUNT>Выбирает учётную запись, от имени которой запускаются оболочки, когда вы включаете терминал от имени root или администратора. Без него команда enable с повышенными правами спрашивает Run shells as user:; в скрипте, где спросить нельзя, она останавливается с сообщением Choose the account for shells with --terminal-user. Без --terminal-user команда без повышенных прав использует текущего пользователя.
--pairing-key #
localtonet --terminal enable --authtoken <YOUR_TOKEN> --terminal-user <ACCOUNT> --pairing-key <PAIRING_KEY>Привязывает устройство, где никто не может прочитать код подтверждения, например сервер, настроенный скриптом. Создайте ключ в разделе Мои устройства в окне Добавить устройство с помощью Создать одноразовый ключ. Он действует один час и может быть использован один раз. С ключом привязки команда не выводит код и не ждёт подтверждения.
localtonet ssh #
localtonet ssh <DEVICE>
localtonet ssh <DEVICE> -- uptime
localtonet ssh <DEVICE> --key <ACCESS_KEY> -- uptimeОткрывает оболочку на одном из ваших устройств или выполняет там одну команду и возвращает её код завершения. <DEVICE> — имя устройства, показанное в разделе Мои устройства. ssh должно быть первым словом после localtonet.
| Часть | Что делает |
|---|---|
-- <COMMAND> | Выполняет команду вместо открытия оболочки. Всё после -- — это команда. |
--key <ACCESS_KEY> | Ключ доступа устройства, созданный в разделе Ключи в Моих устройствах. С ключом подтверждение в браузере не нужно. |
--stdio | Не открывает оболочку. Только передаёт необработанное соединение с устройством через стандартный ввод и вывод, чтобы использовать его как ProxyCommand SSH-клиента. |
Без ключа команда выводит Approve this connection in your browser: со ссылкой и до пяти минут ждёт вашего подтверждения. Если соединение не подтверждено, она завершается сообщением The connection was not approved.
Диагностика и сведения #
--debug #
localtonet --debug --proxy env --authtoken <YOUR_TOKEN>Включает диагностику соединений в стандартном потоке ошибок: используемые маршруты прокси и из какой настройки они взяты, режим DNS, результаты рукопожатия и состояние UDP. Учётные данные и тела запросов не выводятся. --debug также переключает клиент в режим headless, поэтому он ничего не запрашивает. Это флаг, значение ему не нужно.
--version #
localtonet --versionВыводит версию клиента, например v8.6, и завершается.
--help #
localtonet --helpВыводит встроенную справку и завершается. -h делает то же самое.
Переменные окружения #
| Переменная | Действие |
|---|---|
LOCALTONET_HEADLESS | 1 включает режим headless. |
LOCALTONET_AUTH_TOKEN | Токен в режиме headless. |
LOCALTONET_AUTH_TOKEN_FILE | Путь к файлу с токеном в режиме headless. |
http_proxy, https_proxy, all_proxy, no_proxy и их варианты в верхнем регистре | Настройки прокси, только с --proxy env. |
Коды завершения #
| Код | Значение |
|---|---|
0 | Команда завершилась нормально. |
1 | Команда Терминала устройств завершилась ошибкой, например истёк код подтверждения или устройство недоступно. |
2 | Параметр указан неверно или у него нет значения, токен для режима headless непригоден либо пару --net и --ip не удалось применить. |
localtonet ssh <DEVICE> -- <COMMAND> возвращает код завершения удалённой команды.
Примеры #
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