Skip to content

abroadwin/termproxy

 
 

Repository files navigation

termproxy: share a program with others (for pairing!)

termproxy is a shared program tool. It allows you to start the program of your choice (a shell, vim/emacs, etc) and allows others to connect and interact with it via SSH. The intended use case is pairing.

See it in action

Features

  • Share a terminal with your friends or collagues over SSH.
    • start any program -- when it exits, it will terminate the SSH server too.
    • Terminals are resized to fit everyone's terminal on a new connection.
  • Notifications on connection (set -n=false to disable).
  • Read-only mode for connectors: -r
    • present a terminal to others instead of sharing it with them.

Try quickly with Docker

$ docker run -p 1234:1234 -it erikh/termproxy

(in another window)

$ ssh -p 1234 scott@localhost

Note that the standard SSH connection termination sequence is ~.. You can enter this on the SSH side to disconnect from termproxy without stopping the shared program.

Installation

See our releases.

Usage

Server (presumes default settings):

termproxy <program>

Client:

ssh -p <port> scott@host
# password is 'tiger'

There are also options to change the default username -u and password -p, the default of which is scott/tiger.

Author

Erik Hollensbe erik@hollensbe.org

This code also uses a vendored copy of docker/docker's pkg/term to provide the termios support. It is located in the dockerterm directory. This was done to ensure stability of the package.

About

Share a program with others via SSH

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 99.6%
  • Other 0.4%