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

Начало работы

Просмотреть как Markdown Редактировать на GitHub Документация по 1675df8

Установка необходимых компонентов

Для настройки локального туннеля по умолчанию установите на компьютер следующие инструменты:

Node.js 20+

Скачайте с nodejs.org или воспользуйтесь менеджером пакетов.

Командная оболочка
# Check if installed
node --version

tmux

Мультиплексор терминала, который обеспечивает работу сеансов Termbridge.

Командная оболочка
# macOS
brew install tmux

# Ubuntu/Debian
sudo apt install tmux

cloudflared

Создает защищенный туннель к вашему терминалу (не требуется для прямого режима песочницы).

Командная оболочка
# macOS
brew install cloudflared

# Linux - see cloudflare.com/downloads

Скачать cloudflared

Запуск Termbridge

Командная оболочка
npx termbridge

Вы увидите примерно такой вывод:

Код
┌─────────────────────────────────────────┐
│  Termbridge                             │
│                                         │
│  Local:   http://127.0.0.1:51234        │
│  Public:  https://abc123.trycloudflare.com │
│                                         │
│  ██████████████                         │
│  ██          ██  <- Scan this QR code   │
│  ██████████████                         │
│                                         │
└─────────────────────────────────────────┘

Примечание Туннель trycloudflare.com URL — быстрый туннель без учетной записи. Если вы часто используете Termbridge, настройте токен именованного туннеля Cloudflare, чтобы избежать ограничений частоты запросов.

Подключение с телефона

  1. Откройте камеру телефона
  2. Наведите ее на код QR
  3. Нажмите на появившуюся ссылку
  4. Терминал откроется в браузере

Вот и все — подключение установлено!

Что произошло?

  1. Termbridge запустил локальный сервер на вашем компьютере
  2. Он создал сеанс tmux для вашего терминала
  3. Cloudflare создал защищенный туннель (trycloudflare.com URL)
  4. Код QR содержит одноразовый токен для безопасного доступа. Он действует один раз и истекает через 90 секунд после запуска, поэтому отсканируйте его сразу; если срок действия истек, перезапустите Termbridge, чтобы получить новый код
  5. После сканирования вы получили cookie сеанса и подключились

Попробуйте

После подключения попробуйте выполнить несколько команд:

Командная оболочка
# See system info
htop

# Check a git repo
cd ~/your-project && git status

# Run any CLI tool

В терминале поддерживаются все цвета, TUI и все ожидаемые клавиши.

Не закрывайте приложение

Для работы подключения Termbridge должен оставаться запущенным. Когда закончите:

  • Нажмите Ctrl+C в терминале, где работает Termbridge
  • Туннель закроется, и соединение завершится
  • Сеанс tmux останется активным (если только вы не использовали --kill-on-exit)

Поведение первого сеанса

  • Termbridge создает сеанс tmux (имя по умолчанию формируется на основе порта)
  • Первый терминал в списке загружается автоматически
  • При запуске можно создать несколько сеансов, задав TERMBRIDGE_SESSIONS=2

Использование существующего сеанса tmux

Если передать --session <name> и этот сеанс уже существует, Termbridge подключится к нему вместо создания нового. Это удобно для наблюдения за уже запущенными длительными процессами.

Следующие шаги

Управление на мобильных устройствах

Советы по использованию Termbridge на телефонах и планшетах

Несколько терминалов

Запускайте несколько сеансов и переключайтесь между ними

Предпросмотр сервера разработки

Предпросмотр приложения Vite рядом с терминалом

Справочник CLI

Список всех доступных флагов и параметров