Довідник командного рядка
На цій сторінці 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