tty-share
Jump to navigation
Jump to search
tty-share --public --readonly --command bash
Usage:
tty-share creates a session to a terminal application with remote participants. The session can be joined either from the browser, or by tty-share command itself.
tty-share [[--args <"args">] --command <executable>] # share the terminal and get a session URL, as a server
[--logfile <file name>] [--listen <[ip]:port>]
[--frontend-path <path>] [--tty-proxy <host:port>]
[--readonly] [--public] [no-tls] [--verbose] [--version]
tty-share [--verbose] [--logfile <file name>] [-L <local_port>:<remote_host>:<remote_port>]
[--detach-keys] <session URL> # connect to an existing session, as a client
Examples:
Start bash and create a public sharing session, so it's accessible outside the local network, and make the session read only:
tty-share --public --readonly --command bash
Join a remote session by providing the URL created another tty-share command:
tty-share http://localhost:8000/s/local/
Flags:
[c] - flags that are used only by the client
[s] - flags that are used only by the server
-A [s] Allow clients to create a TCP tunnel
-L string
[c] TCP tunneling addresses: local_port:remote_host:remote_port. The client will listen on local_port for TCP connections, and will forward those to the from the server side to remote_host:remote_port
-args string
[s] The command arguments
-command string
[s] The command to run (default "/bin/zsh")
-detach-keys string
[c] Sequence of keys to press for closing the connection. Supported: https://godoc.org/github.com/moby/term#pkg-variables. (default "ctrl-o,ctrl-c")
-frontend-path string
[s] The path to the frontend resources. By default, these resources are included in the server binary, so you only need this path if you don't want to use the bundled ones.
-headless
[s] Don't expect an interactive terminal at stdin
-headless-cols int
[s] Number of cols for the allocated pty when running headless (default 80)
-headless-rows int
[s] Number of rows for the allocated pty when running headless (default 25)
-listen string
[s] tty-server address (default "localhost:8000")
-logfile string
The name of the file to log (default "-")
-no-tls
[s] Don't use TLS to connect to the tty-proxy server. Useful for local debugging
-no-wait
[s] Don't wait for the Enter press before starting the session
-public
[s] Create a public session
-readonly
[s] Start a read only session
-tty-proxy string
[s] Address of the proxy for public facing connections (default "on.tty-share.com:4567")
-verbose
Verbose logging
-version
Print the tty-share version
brew install tty-share apt install tty-share
Related[edit]
tmate Visual Studio Code Live Share
See also[edit]
Advertising:
