Справочник команд proximamp
Все команды proximamp, их параметры и коды выхода. Ту же справку в терминале покажет proximamp help <команда>.
Справка proximamp 1.0.1.
proximamp <команда> [аргументы] [параметры]| Команда | Что делает |
|---|---|
help | Справка по proximamp, по команде или по кодам выхода |
version | Показать версию proximamp |
login | Войти на этом компьютере: паролем, через VK ID или Яндекс ID в браузере, ключом устройства или кодом, подтверждённым с телефона |
signup | Завести аккаунт ProximaMP: логин, почта и пароль или через VK ID или Яндекс ID |
verify | Подтвердить почту нового аккаунта кодом из письма или попросить новый код |
password | Пароль аккаунта: сбросить забытый, задать первый или сменить |
email | Почта аккаунта: показать, добавить и подтвердить кодом из письма |
logout | Выйти из аккаунта на этом компьютере |
whoami | Показать, в какой аккаунт выполнен вход на этом компьютере |
keys | Ключи устройств, которыми входят сервер, служба или контейнер: создать, показать, отозвать |
devices | Где выполнен вход в аккаунт: показать устройства, переименовать, завершить вход на одном |
account | Показать тариф аккаунта, срок оплаты и расход |
plans | Показать тарифы (работает и без входа) |
payments | Показать платежи аккаунта |
buy | Купить тариф: печатает ссылку на страницу оплаты и QR-код для телефона |
up | Открыть все туннели из proximamp.yml и держать их открытыми до Ctrl+C |
service | Держать туннели из конфига службой, которая запускается вместе с компьютером |
update | Обновить proximamp до последней версии |
tcp | Открыть TCP-порт этого компьютера в интернет и держать открытым до Ctrl+C |
udp | Открыть UDP-порт этого компьютера в интернет и держать открытым до Ctrl+C |
http | Дать сайту на этом компьютере ссылку https и держать её до Ctrl+C |
https | Дать ссылку https сайту на этом компьютере, который сам работает по https, и держать её до Ctrl+C |
ls | Показать открытые туннели аккаунта |
close | Закрыть туннель этого компьютера по его номеру или адресу |
addresses | Показать адреса, которые аккаунт держит за закрытыми туннелями, или отпустить адрес |
inspect | Показать запросы к ссылке этого компьютера в браузере (инспектор) или с --text строками здесь, до Ctrl+C |
access | Решить, кто может зайти на адрес: белый и чёрный списки, ограничения на посетителя, логин или ключ на ссылке |
proximamp help
Справка по proximamp, по команде или по кодам выхода
proximamp help [<команда> | exit-codes]proximamp version
Показать версию proximamp
proximamp versionproximamp login
Войти на этом компьютере: паролем, через VK ID или Яндекс ID в браузере, ключом устройства или кодом, подтверждённым с телефона
proximamp login [<логин>] [--password-stdin]
proximamp login --vk | --yandex
proximamp login --key | --key-stdin
proximamp login --remote [<логин>]| Параметр | Описание |
|---|---|
--password-stdin | Прочитать пароль со стандартного ввода, одной строкой (текущий и новый: по строке) |
--vk | Войти через VK ID в браузере |
--yandex | Войти через Яндекс ID в браузере |
--no-browser | Не открывать браузер, только напечатать ссылку |
--accept-terms | Принять условия использования (https://proximamp.com/terms) без вопроса |
--new-account | Если почта из VK ID или Яндекс ID уже есть у аккаунта, завести отдельный новый |
--key | Войти ключом устройства, введя его скрыто |
--key-stdin | Войти ключом устройства со стандартного ввода, одной строкой |
--remote | Войти кодом, который вы подтвердите с телефона или другого компьютера, для машины без браузера; логин после него оставит вход, только если это тот аккаунт, а без терминала он обязателен |
proximamp signup
Завести аккаунт ProximaMP: логин, почта и пароль или через VK ID или Яндекс ID
proximamp signup [--login <логин>] [--email <почта>] [--password-stdin] [--accept-terms]
proximamp signup --vk | --yandex| Параметр | Описание |
|---|---|
--login логин | Логин нового аккаунта |
--email почта | Почта нового аккаунта |
--password-stdin | Прочитать пароль со стандартного ввода, одной строкой (текущий и новый: по строке) |
--accept-terms | Принять условия использования (https://proximamp.com/terms) без вопроса |
--vk | Войти через VK ID в браузере |
--yandex | Войти через Яндекс ID в браузере |
--no-browser | Не открывать браузер, только напечатать ссылку |
--new-account | Если почта из VK ID или Яндекс ID уже есть у аккаунта, завести отдельный новый |
proximamp verify
Подтвердить почту нового аккаунта кодом из письма или попросить новый код
proximamp verify <логин> [<код>]
proximamp verify <логин> --resend| Параметр | Описание |
|---|---|
--resend | Отправить новый код на почту аккаунта |
proximamp password
Пароль аккаунта: сбросить забытый, задать первый или сменить
proximamp password reset [<почта>] [--code-stdin] [--password-stdin]
proximamp password set [--password-stdin]
proximamp password change [--password-stdin]| Параметр | Описание |
|---|---|
--code-stdin | Прочитать код из письма со стандартного ввода, первой строкой (новый пароль с --password-stdin следующей) |
--password-stdin | Прочитать пароль со стандартного ввода, одной строкой (текущий и новый: по строке) |
--vk | Войти через VK ID в браузере |
--yandex | Войти через Яндекс ID в браузере |
--no-browser | Не открывать браузер, только напечатать ссылку |
proximamp email
Почта аккаунта: показать, добавить и подтвердить кодом из письма
proximamp email
proximamp email add [<почта>] [--password-stdin | --vk | --yandex] [--no-browser]
proximamp email confirm [<код>]| Параметр | Описание |
|---|---|
--password-stdin | Прочитать пароль со стандартного ввода, одной строкой (текущий и новый: по строке) |
--vk | Войти через VK ID в браузере |
--yandex | Войти через Яндекс ID в браузере |
--no-browser | Не открывать браузер, только напечатать ссылку |
proximamp logout
Выйти из аккаунта на этом компьютере
proximamp logoutproximamp whoami
Показать, в какой аккаунт выполнен вход на этом компьютере
proximamp whoamiproximamp keys
Ключи устройств, которыми входят сервер, служба или контейнер: создать, показать, отозвать
proximamp keys [ls]
proximamp keys create --name <имя> [--protection] [--usage] [--expires 30|90] [--password-stdin | --vk | --yandex]
proximamp keys revoke <id> [--yes]| Параметр | Описание |
|---|---|
--name имя | Имя ключа, от 1 до 48 символов |
--protection | Ключ может и защищать адреса: белый и чёрный списки, логины и ключи на ссылках |
--usage | Ключ может и смотреть тариф и расход |
--expires дни | Ключ истечёт через 30 или 90 дней; без этого параметра он не истекает |
--password-stdin | Прочитать пароль со стандартного ввода, одной строкой (текущий и новый: по строке) |
--vk | Войти через VK ID в браузере |
--yandex | Войти через Яндекс ID в браузере |
--no-browser | Не открывать браузер, только напечатать ссылку |
--yes | Сделать без вопроса |
proximamp devices
Где выполнен вход в аккаунт: показать устройства, переименовать, завершить вход на одном
proximamp devices
proximamp devices rename <id> <имя>
proximamp devices sign-out <id> [--yes]| Параметр | Описание |
|---|---|
--yes | Сделать без вопроса |
proximamp account
Показать тариф аккаунта, срок оплаты и расход
proximamp accountproximamp plans
Показать тарифы (работает и без входа)
proximamp plansproximamp payments
Показать платежи аккаунта
proximamp paymentsproximamp buy
Купить тариф: печатает ссылку на страницу оплаты и QR-код для телефона
proximamp buy <тариф>proximamp up
Открыть все туннели из proximamp.yml и держать их открытыми до Ctrl+C
proximamp up [--config <файл> | -c <файл>]| Параметр | Описание |
|---|---|
--config файл | Какой конфиг читать (если не указано, proximamp.yml в текущей папке) |
-c файл | Какой конфиг читать (если не указано, proximamp.yml в текущей папке) |
--wait-sign-in | Без входа ждать вход, а не завершаться, и повторять туннель, которому отказали (так работает служба) |
proximamp service
Держать туннели из конфига службой, которая запускается вместе с компьютером
proximamp service install [<логин>] [-c <файл>] [--password-stdin | --key-stdin]
proximamp service login [<логин>] [--password-stdin | --key-stdin]
proximamp service status
proximamp service inspect [<ссылка | номер>] [--port <порт> | --text]
proximamp service access <адрес> [<слова и параметры proximamp access>]
proximamp service uninstall [--yes]| Параметр | Описание |
|---|---|
--config файл | Какой конфиг читать (если не указано, proximamp.yml в текущей папке) |
-c файл | Какой конфиг читать (если не указано, proximamp.yml в текущей папке) |
--password-stdin | Прочитать пароль со стандартного ввода, одной строкой (текущий и новый: по строке) |
--key-stdin | Войти ключом устройства со стандартного ввода, одной строкой |
--yes | Сделать без вопроса |
--text | Запросы строками в этом терминале, а не в браузере: для сервера, где страницу не открыть |
--port порт | Порт на 127.0.0.1 для страницы инспектора; без него берётся свободный |
--deny | use: подключить список как чёрный |
--ban-per-minute n | limit: банить адрес посетителя, если новых подключений в минуту больше этого (от 5 до 1000, off, default) |
--ban-minutes n | limit: сколько длится бан, от 1 до 1440 минут, или default |
--tcp-share n | limit: сколько TCP-подключений держит один адрес посетителя, от 1 до 128, или default |
--udp-share n | limit: сколько UDP-потоков держит один адрес посетителя, от 1 до 256, или default |
--overlap минуты | key rotate: сколько минут работает старый ключ: 0, 60 (если не указано), 1440 или 10080 |
--burst n | requests, key limit: сколько запросов пропускать разом сверх нормы |
--methods список | rule add: только эти методы, через запятую (GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS) |
--at n | rule add: место правила, 1 первое (если не указано, последнее) |
--minutes n | failures: за сколько минут считать неудачные попытки |
--pause минуты | failures: на сколько минут приостанавливать адрес посетителя |
proximamp update
Обновить proximamp до последней версии
proximamp updateproximamp tcp
Открыть TCP-порт этого компьютера в интернет и держать открытым до Ctrl+C
proximamp tcp <порт> [--udp] [--host <хост>] [--address <адрес> | --new]| Параметр | Описание |
|---|---|
--udp | Тот же порт отвечает и по UDP (игровой сервер, которому нужны оба) |
--host хост | Отправлять посетителей на этот хост, а не на этот компьютер (другой компьютер вашей сети) |
--address адрес | Открыть на этом удержанном адресе (см. proximamp addresses) |
--new | Взять новый адрес, а не тот, что был у этого туннеля в прошлый раз |
proximamp udp
Открыть UDP-порт этого компьютера в интернет и держать открытым до Ctrl+C
proximamp udp <порт> [--host <хост>] [--address <адрес> | --new]| Параметр | Описание |
|---|---|
--host хост | Отправлять посетителей на этот хост, а не на этот компьютер (другой компьютер вашей сети) |
--address адрес | Открыть на этом удержанном адресе (см. proximamp addresses) |
--new | Взять новый адрес, а не тот, что был у этого туннеля в прошлый раз |
proximamp http
Дать сайту на этом компьютере ссылку https и держать её до Ctrl+C
proximamp http <порт> [--host <хост>] [--address <ссылка> | --new] [--inspect]| Параметр | Описание |
|---|---|
--host хост | Отправлять посетителей на этот хост, а не на этот компьютер (другой компьютер вашей сети) |
--address адрес | Открыть на этом удержанном адресе (см. proximamp addresses) |
--new | Взять новый адрес, а не тот, что был у этого туннеля в прошлый раз |
--inspect | Показывать запросы к ссылке в браузере, как proximamp inspect |
proximamp https
Дать ссылку https сайту на этом компьютере, который сам работает по https, и держать её до Ctrl+C
proximamp https <порт> [--host <хост>] [--address <ссылка> | --new] [--inspect]| Параметр | Описание |
|---|---|
--host хост | Отправлять посетителей на этот хост, а не на этот компьютер (другой компьютер вашей сети) |
--address адрес | Открыть на этом удержанном адресе (см. proximamp addresses) |
--new | Взять новый адрес, а не тот, что был у этого туннеля в прошлый раз |
--inspect | Показывать запросы к ссылке в браузере, как proximamp inspect |
proximamp ls
Показать открытые туннели аккаунта
proximamp lsproximamp close
Закрыть туннель этого компьютера по его номеру или адресу
proximamp close <номер | адрес>proximamp addresses
Показать адреса, которые аккаунт держит за закрытыми туннелями, или отпустить адрес
proximamp addresses [release <адрес>] [--yes]| Параметр | Описание |
|---|---|
--yes | Сделать без вопроса |
proximamp inspect
Показать запросы к ссылке этого компьютера в браузере (инспектор) или с --text строками здесь, до Ctrl+C
proximamp inspect [<ссылка | номер>] [--no-browser] [--port <порт>]
proximamp inspect --text [<ссылка | номер>]| Параметр | Описание |
|---|---|
--no-browser | Не открывать браузер, только напечатать ссылку |
--port порт | Порт на 127.0.0.1 для страницы инспектора; без него берётся свободный |
--text | Запросы строками в этом терминале, а не в браузере: для сервера, где страницу не открыть |
proximamp access
Решить, кто может зайти на адрес: белый и чёрный списки, ограничения на посетителя, логин или ключ на ссылке
proximamp access <адрес> [allow|deny|remove <ip или диапазон>... | clear]
proximamp access <адрес> limit [--ban-per-minute <n>|off] [--ban-minutes <n>] [--tcp-share <n>] [--udp-share <n>]
proximamp access <адрес> limit default
proximamp access <адрес> use <список> [--deny]
proximamp access <адрес> drop <список>
proximamp access lists
proximamp access lists create <имя> [<ip или диапазон>...]
proximamp access lists set|add|remove <список> <ip или диапазон>...
proximamp access lists rename <список> <имя>
proximamp access lists delete <список>
proximamp access <ссылка> login add|password|on|off|remove <логин> [--password-stdin]
proximamp access <ссылка> key add|rotate|show|remove <имя> [--overlap <минуты>]
proximamp access <ссылка> key limit <имя> <в минуту>|off [--burst <n>]
proximamp access <ссылка> rule add <путь> open|login|addresses [<ip или диапазон>...] [--methods GET,POST] [--at <n>]
proximamp access <ссылка> rule remove <n>
proximamp access <ссылка> rule clear
proximamp access <ссылка> requests anonymous|signed-in|keys <в минуту>|off [--burst <n>]
proximamp access <ссылка> failures password|key <число>|off|default [--minutes <n>] [--pause <минуты>]
proximamp access <ссылка> sign-out-everyone
proximamp access <ссылка> unpause <адрес посетителя>| Параметр | Описание |
|---|---|
--yes | Согласиться заранее: удалить общий список или оставить адрес открытым для всех |
--deny | use: подключить список как чёрный |
--ban-per-minute n | limit: банить адрес посетителя, если новых подключений в минуту больше этого (от 5 до 1000, off, default) |
--ban-minutes n | limit: сколько длится бан, от 1 до 1440 минут, или default |
--tcp-share n | limit: сколько TCP-подключений держит один адрес посетителя, от 1 до 128, или default |
--udp-share n | limit: сколько UDP-потоков держит один адрес посетителя, от 1 до 256, или default |
--password-stdin | Прочитать пароль со стандартного ввода, одной строкой (текущий и новый: по строке) |
--overlap минуты | key rotate: сколько минут работает старый ключ: 0, 60 (если не указано), 1440 или 10080 |
--burst n | requests, key limit: сколько запросов пропускать разом сверх нормы |
--methods список | rule add: только эти методы, через запятую (GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS) |
--at n | rule add: место правила, 1 первое (если не указано, последнее) |
--minutes n | failures: за сколько минут считать неудачные попытки |
--pause минуты | failures: на сколько минут приостанавливать адрес посетителя |
Параметры любой команды
| Параметр | Описание |
|---|---|
--json | Вывести результат в JSON, для скриптов |
-h, --help | Показать справку по команде |
--version | Показать версию proximamp |
Коды выхода
| Код | Значение |
|---|---|
0 | готово |
1 | не получилось по причине, которой нет в этом списке |
2 | команда набрана неверно: неизвестная команда или параметр, не хватает аргумента или он лишний |
3 | вход не выполнен или закончился: выполните proximamp login |
4 | нет связи с ProximaMP: проверьте интернет и повторите |
5 | ProximaMP отказал: лимит или тариф, неверный пароль, или того, о чём просили, нет |
6 | не удалось запустить агент proximamp на этом компьютере или связаться с ним |
7 | эта версия proximamp слишком старая для ProximaMP: обновите её |
130 | остановлено нажатием Ctrl+C |