📖 Справочник команд

Команды, изменяющие ваш текущий shell (on, off, use, switch, best), должны вызываться через shell-функцию proxy, устанавливаемую при интеграции с оболочкой. Остальные работают и с полным именем бинарника.

Принимаются любой подкомандой, до или после неё.

Переменная NO_COLOR (любое непустое значение) отключает цветной вывод.

# Рабочие и личные прокси в разных файлах
TSPM_CONFIG=~/work-proxies.json proxy best
tspm --config-file ~/work-proxies.json profile list

proxy on                     # Экспортировать переменные прокси в эту сессию
proxy off                    # Убрать их
tspm env on   # Показать команды, не применяя их

proxy on — это выполнение вывода env on. Обе команды задают каждую переменную в обоих регистрах (http_proxy и HTTP_PROXY и так далее), а также GRADLE_OPTS и JAVA_TOOL_OPTIONS, потому что разные инструменты читают разные имена. off снимает ровно тот же набор.

Значения экранируются по правилам POSIX, поэтому хост с shell-синтаксисом безопасен.

proxy status         # Состояние прокси, IPv4, IPv6 и геолокация
proxy status --json  # То же самое в машиночитаемом виде

JSON пригоден для скриптов:

proxy status --json | jq -r .ipv4

proxy profile list                 # Все профили, активный отмечен
proxy switch                       # Интерактивный выбор стрелками
proxy use work                     # Переключение по ключу

proxy profile set work \
  --name "Рабочий SOCKS" \
  --host 127.0.0.1 \
  --port 1080 \
  --protocol socks5                # Создать или изменить и сделать активным

proxy profile remove work          # Удалить

profile set сохраняет профиль активным, но не меняет переменные текущей оболочки. Если прокси включён, выполните затем proxy use work (или proxy on), чтобы применить его.

--protocol принимает http, https, socks4, socks4a, socks5, socks5h. Не указанные поля у существующего профиля сохраняют прежние значения.

Профили проверяются перед сохранением: хост должен быть корректным именем или IP, порт — ненулевым, протокол — поддерживаемым. Неизвестный ключ профиля даёт ненулевой код возврата, поэтому такая конструкция работает как ожидается:

proxy use work || proxy best

proxy import ./proxies.json
proxy import https://example.com/subscription.txt

Распознаются четыре формата: полный config.json, простое соответствие ключа профилю, массив профилей и список прокси-URL по одному в строке (socks5://host:port, комментарии через #). Некорректные записи пропускаются с сообщением, остальные импортируются.

proxy benchmark            # Задержка и доступность всех профилей
proxy best                 # Замерить и переключиться на самый быстрый
proxy ping                 # Задержка до эндпоинтов из config.json
proxy ping --timeout 2000  # С таймаутом 2 с
proxy speedtest            # Реальная скорость загрузки

benchmark проверяет профили по очереди, опрашивая все цели одного профиля одновременно. Недоступные профили оказываются в конце списка и отображаются как таймаут, а не числом.

proxy dash

Чтобы Enter обновил вашу сессию, нужна функция proxy_dash из интеграции с shell — запускайте proxy dash, а не бинарник напрямую.

proxy diagnose  # Локальный сокет, переменные сессии и доступность эндпоинтов
proxy monitor   # Проверка состояния; при сбое выбирает самый быстрый профиль

monitor проверяет health_check_url из config.json через тот прокси, который сейчас установлен в вашем окружении, — ALL_PROXY, all_proxy или http_proxy. Если проверка не прошла или ни одна из этих переменных не задана, он замеряет профили и сохраняет самый быстрый доступный как активный. Переменные оболочки, в которой он запущен, он не меняет: примените новый профиль там через proxy on или выполните proxy on в новой оболочке.

diagnose показывает из сессии http_proxy, https_proxy, ALL_PROXY и GRADLE_OPTS. Полный набор переменных, которые экспортирует proxy on, покажет env | grep -i proxy.

proxy run curl https://example.com
proxy run -- curl -sS https://example.com
proxy run npm install

Выполняет одну команду с переменными прокси, не меняя вашу сессию. Код возврата дочернего процесса передаётся наружу, поэтому proxy run ... && next-step работает корректно. Флаги передаются как есть; -- необязателен.

proxy git status  # Показать текущий глобальный прокси для git
proxy git on      # Направить git через активный профиль
proxy git off     # Отключить проксирование git

proxy export envfile > .env
proxy export docker    # Флаги --build-arg
proxy export curl      # Флаг -x

Завершается с ошибкой, если активного профиля нет, поэтому перенаправление не создаст пустой файл незаметно.

proxy config path        # Какой config.json используется
proxy config show        # Показать его
proxy settings path
proxy settings show
proxy settings set --config-path ~/proxies.json
proxy lang ru            # Сохранить язык интерфейса

tspm init zsh          # Скрипт интеграции
tspm completions zsh   # Только автодополнение
proxy prompt                                     # Индикатор для приглашения
proxy debug on                                   # Логировать обмен с shell

completions поддерживает zsh, bash, fish и powershell. init уже включает автодополнение, поэтому достаточно чего-то одного.

Включайте debug on, если proxy dash не обновляет сессию: обмен пишется в ~/.tspm-debug.log.