Aller au contenu

Premiers pas

Afficher au format Markdown Modifier sur GitHub Documentation de 1675df8

Installer les prérequis

Pour utiliser la configuration par défaut du tunnel local, installez ces outils sur votre ordinateur :

Node.js 20+

Téléchargez depuis nodejs.org ou utilisez votre gestionnaire de paquets.

Shell
# Check if installed
node --version

tmux

Le multiplexeur de terminaux qui alimente les sessions Termbridge.

Shell
# macOS
brew install tmux

# Ubuntu/Debian
sudo apt install tmux

cloudflared

Crée un tunnel sécurisé vers votre terminal (inutile en mode direct dans un environnement isolé).

Shell
# macOS
brew install cloudflared

# Linux - see cloudflare.com/downloads

Télécharger cloudflared

Lancer Termbridge

Shell
npx termbridge

Voici un exemple de sortie :

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

Remarque Le tunnel trycloudflare.com URL est rapide et ne nécessite pas de compte. Si vous utilisez fréquemment Termbridge, configurez un jeton de tunnel nommé Cloudflare pour éviter les limites de débit.

Se connecter depuis votre téléphone

  1. Ouvrez l'appareil photo de votre téléphone
  2. Pointez-le vers le code QR
  3. Touchez le lien qui s'affiche
  4. Votre terminal s'ouvre dans le navigateur

Voilà, vous êtes connecté !

Que vient-il de se passer ?

  1. Termbridge a démarré un serveur local sur votre machine
  2. Une session tmux a été créée pour votre terminal
  3. Cloudflare a créé un tunnel sécurisé (le trycloudflare.com URL)
  4. Le code QR contient un jeton à usage unique pour un accès sécurisé. Il ne fonctionne qu'une fois et expire 90 secondes après le démarrage : scannez-le rapidement. S'il a expiré, redémarrez Termbridge pour en obtenir un nouveau
  5. En le scannant, vous avez obtenu un cookie de session et vous vous êtes connecté

Essayez

Une fois connecté, essayez quelques commandes :

Shell
# See system info
htop

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

# Run any CLI tool

Le terminal prend en charge les couleurs, les interfaces TUI et toutes les touches habituelles.

Laisser le service actif

Termbridge doit rester en cours d'exécution pour que la connexion fonctionne. Lorsque vous avez terminé :

  • Appuyez sur Ctrl+C dans le terminal où Termbridge est en cours d'exécution
  • Le tunnel se ferme et la connexion est interrompue
  • Votre session tmux reste active (sauf si vous avez utilisé --kill-on-exit)

Comportement de la première session

  • Termbridge crée une session tmux (le nom par défaut est dérivé du port)
  • Le premier terminal de la liste se charge automatiquement
  • Vous pouvez créer plusieurs sessions au démarrage en définissant TERMBRIDGE_SESSIONS=2

Utiliser une session tmux existante

Si vous indiquez --session <name> et que cette session existe déjà, Termbridge s'y rattache au lieu d'en créer une nouvelle. C'est utile pour surveiller des processus de longue durée que vous avez déjà lancés.

Étapes suivantes

Commandes mobiles

Conseils pour utiliser Termbridge sur téléphone et tablette

Plusieurs terminaux

Exécutez plusieurs sessions et passez de l'une à l'autre

Aperçu du serveur de développement

Affichez l'aperçu de votre application Vite à côté du terminal

Référence CLI

Consultez tous les indicateurs et options disponibles