Skip to content

Latest commit

 

History

History
32 lines (21 loc) · 1.55 KB

README.md

File metadata and controls

32 lines (21 loc) · 1.55 KB
Raw

📺 Muxile

Putting tmux on your mobile

Muxile is a tmux plugin that lets you move your running tmux session to your phone, without needing any app. Use it to keep watching a long-running process, to re-run it if it fails, or to just control your terminal remotely. You can also be used to quickly share your session with someone.

output.mp4

How to use

  1. Install the plugin using TPM or load it by running ./muxile.tmux
  2. Open a tmux session
  3. Use prefix+T (Shift+T) to share your tmux session
  4. Muxile will load and will give you a link and QR code (go back to your terminal with Ctrl+C)
  5. Scan the QR code with your phone and open the link
  6. Magic! It's tmux on your phone
  7. Use the input at the bottom to send commands back to tmux
  8. Use prefix+T (Shift+T) to stop the session sharing

Requirements

  • qrencode (pacman -S qrencode, apt install qrencode)
  • jq (pacman -S jq, apt install jq)
  • websocat (pacman -S websocat)

How it works

Muxile uses a Cloudflare Worker that serves as WebSocket server and allows the communication between tmux and the remote viewer. It uses websocat to send data from and to tmux over UNIX sockets. The backend code is here and you're free to run your own if you want.

See also