Перейти к содержимому

Справочник CLI

Агент на управляемой машине. Запущенный без подкоманды работает как демон: подключается к серверу управления и обслуживает сессии, реле и команды воркеров. Так его и запускает systemd-юнит или служба Windows.

nythronix-agent [ГЛОБАЛЬНЫЕ ФЛАГИ] [ПОДКОМАНДА]
Флаг Переменная окружения Назначение
--url <URL> NYTHRONIX_SERVER_WS адрес сервера управления, например wss://nx.3fe.ru/agent/ws; если не задан, берётся из сохранённого конфига
--login <LOGIN> NYTHRONIX_AGENT_LOGIN логин агента; если не задан, берётся из конфига
--password <PASSWORD> NYTHRONIX_AGENT_PASSWORD пароль агента; если не задан, берётся из конфига
--hostname <NAME> — имя, которое сообщается панели; по умолчанию hostname системы
--config <PATH> NYTHRONIX_AGENT_CONFIG путь к файлу конфигурации; можно указывать до или после подкоманды
--help, --version — справка и версия

Путь конфигурации по умолчанию: /etc/nythronix/agent.json на Linux, %ProgramData%\Nythronix\agent.json на Windows. Файл создаёт enroll; в нём лежат адрес сервера, логин, пароль, ID агента и закреплённые ключи проверки обновлений.

Дополнительно на Linux читается NYTHRONIX_TRUSTED_KEYS — список hex-ключей Ed25519 через запятую; они объединяются с ключами из конфига.

Регистрирует машину по токену: отправляет токен на сервер, получает постоянные учётные данные и сохраняет их в конфиг. Существующие учётные данные не требуются.

Окно терминала
nythronix-agent enroll --token nyxet_… --url wss://nx.3fe.ru/agent/ws [--hostname NAME] [--display-name NAME]
Флаг Переменная окружения Назначение
--token <TOKEN> NYTHRONIX_ENROLL_TOKEN токен регистрации nyxet_… (обязателен)
--url <URL> NYTHRONIX_SERVER_WS адрес сервера; принимаются формы https://…, wss://…/agent/ws и т. п. (обязателен)
--hostname <NAME> — hostname, который сообщается серверу; по умолчанию hostname системы
--display-name <NAME> NYTHRONIX_DISPLAY_NAME понятное имя машины, которое показывается в кабинете (необязательно)

Генерирует одноразовый код доступа к этой машине. Выполнение команды и есть согласие владельца. См. Доступ по коду согласия.

Окно терминала
nythronix-agent share [--session <ID>] [--view-only] [--ttl <SECONDS>]
Флаг Назначение
--session <ID> дать доступ к существующей сессии вместо новой оболочки
--view-only оператор может смотреть, но не печатать
--ttl <SECONDS> срок действия кода в секундах (по умолчанию 3600)

Открывает на этой машине локальный TCP-порт, ведущий через реле панели к loopback-порту другого агента той же организации. У целевого агента должно быть включено «Реле». Использует учётные данные этого агента. См. SSH-реле и туннели.

Окно терминала
nythronix-agent tunnel <TARGET_AGENT_ID> [--port <PORT>] [--listen <ADDR>]
Аргумент / флаг Назначение
<TARGET_AGENT_ID> ID целевого агента (позиционный, обязателен)
--port <PORT> порт на loopback цели (по умолчанию 22)
--listen <ADDR> локальный адрес прослушивания (по умолчанию 127.0.0.1:2222)

Работает до Ctrl-C.

Управление агентом как службой Windows. Служба называется NythronixAgent, работает от LocalSystem, стартует автоматически и перезапускается при сбое. Учётные данные читает из конфига, записанного enroll. Требует командной строки администратора.

nythronix-agent service install зарегистрировать службу
nythronix-agent service uninstall удалить регистрацию службы
nythronix-agent service start запустить службу
nythronix-agent service stop остановить службу
nythronix-agent service run точка входа для диспетчера служб; вручную не вызывается

CLI оператора для вашей рабочей машины. Авторизуется API-токеном из кабинета («Настройки → API-токены»), показывает список машин и открывает реле-туннели к агентам.

Инструменты оператора ставятся и обновляются одной командой — см. Рабочее место оператора. Если вы работаете через Claude Code, см. MCP для операторов.

nyx-operator <ПОДКОМАНДА>

Обычный порядок работы:

Окно терминала
nyx-operator agents # все машины таблицей
nyx-operator agents --online --tag env:prod # сузить список
nyx-operator agents касса # поиск по имени, hostname, логину и тегам
nyx-operator tunnel касса-1 --port 22 # локальный порт → реле → машина
ssh -p 2222 admin@127.0.0.1 # в другом терминале

Машины адресуются по имени, а не по ID: подходит имя из кабинета, hostname, логин агента или ID. Правила сопоставления описаны в разделе tunnel.

Проверяет токен запросом к /api/me и сохраняет адрес сервера и токен в ~/.config/nythronix/operator.json (права 0600). Выполняется один раз на машину.

Окно терминала
nyx-operator login --server https://app.nx.3fe.ru --token nyxop_…
Флаг Назначение
--server <URL> адрес сервера управления (обязателен)
--token <TOKEN> API-токен оператора nyxop_… (обязателен)

Токен вы выпускаете сами в кабинете («Настройки → API-токены»); значение показывается один раз, при создании. Администратор не может выпустить токен за вас.

Файл с учётными данными общий для nyx-operator и MCP-сервера, поэтому входить второй раз не нужно. Храните его как SSH-ключ.

Переменные окружения NYX_SERVER и NYX_TOKEN, если заданы обе, имеют приоритет над файлом при выполнении остальных команд.

Выводит список агентов, видимых оператору, таблицей со столбцами NAME, HOST, STATE, OS, VERSION, RELAY, TAGS: имя, hostname, состояние (online / offline), ОС, версия агента, включено ли реле и теги. В столбце NAME стоит имя машины из кабинета, а если оно не задано — hostname.

Окно терминала
nyx-operator agents [QUERY] [--online] [--os <OS>] [--tag <KEY:VALUE>]… [--ids] [--json]
Аргумент / флаг Назначение
[QUERY] произвольный текст: поиск подстроки в имени, hostname, логине и тегах (позиционный, необязателен)
--online только машины, подключённые прямо сейчас
--os <OS> только указанная ОС, как её сообщает агент: linux, windows, windows7
--tag <KEY:VALUE> только машины с этим тегом; флаг можно повторять, тогда должны совпасть все теги
--ids добавить столбец ID (нужен только для скриптов — команды принимают имена)
--json вывести строки в JSON вместо таблицы

Все фильтры сочетаются по «И», регистр букв не учитывается. Теги в --tag сравниваются целиком, как в панели фильтров кабинета; поиск по части тега делает QUERY.

Окно терминала
nyx-operator agents --online --tag client:uut --tag role:kassa
nyx-operator agents касса --os windows7
nyx-operator agents --json

Под таблицей печатается итог вида 3 shown (2 online) of 12 total. Он выводится в stderr, поэтому таблицу можно передавать по конвейеру без лишних строк. Если под фильтр не подошла ни одна машина, команда сообщает об этом и показывает общее число машин.

В JSON у каждой строки поля id, name, hostname, login, online, os, version, tags, relay_enabled.

Открывает локальный TCP-порт, ведущий через реле к loopback-порту машины. Подходит любой TCP-порт, не только SSH: 22 для SSH, 3389 для RDP, 5432 для PostgreSQL. См. SSH-реле и туннели.

Окно терминала
nyx-operator tunnel <AGENT> [--port <PORT>] [--listen <ADDR>]
Аргумент / флаг Назначение
<AGENT> машина: имя из кабинета, hostname, логин агента или ID (позиционный, обязателен)
--port <PORT> порт на loopback самой машины (по умолчанию 22)
--listen <ADDR> локальный адрес прослушивания (по умолчанию 127.0.0.1:2222); с портом 0, например 127.0.0.1:0, свободный порт выберет ОС
Окно терминала
nyx-operator tunnel uut_kassa_1 --port 22 --listen 127.0.0.1:2222
ssh -p 2222 <user>@127.0.0.1 # в другом терминале

Как подбирается машина:

  1. Сначала ищется точное совпадение с именем, hostname, логином или ID. Регистр букв не учитывается.
  2. Если точного совпадения нет, подходит подстрока имени, hostname или логина либо начало ID. Достаточно, чтобы подстрока была уникальной.
  3. Если подошло несколько записей и ровно одна из них в сети, выбирается она. Так запись, оставшаяся после повторной регистрации машины, не мешает обратиться к действующей.
  4. Если выбрать однозначно нельзя, команда завершается ошибкой и перечисляет подошедшие машины — уточните имя. Если не подошла ни одна, посмотрите список через nyx-operator agents.

Перед открытием порта команда печатает в stderr, какую машину она выбрала: target: uut_kassa_1 (KASSA1, online). Затем выводит строку tunnel: 127.0.0.1:2222 -> agent … :22 (Ctrl-C to stop) и работает до Ctrl-C.

Префикс Что это
nyxet_… токен регистрации агента (Админ → Агенты → Токены подключения)
nyxop_… API-токен оператора для nyx-operator (Настройки → API-токены)
xxxx-xxxx-xxxx код согласия из nythronix-agent share (12 шестнадцатеричных символов)