b15227c696 | ||
---|---|---|
Godeps | ||
app | ||
libapps@9dc111b58c | ||
resources | ||
.gitignore | ||
.gitmodules | ||
LICENSE | ||
Makefile | ||
README.md | ||
main.go | ||
screenshot.gif | ||
wercker.yml |
README.md
GoTTY - Share your terminal as a web application
GoTTY is a simple command line tool that turns your CLI tools into web applications.
Installation
Download the latest binary file from the Releases page.
Homebrew Installation
You can install gotty with Homebrew as well.
$ brew tap yudai/gotty
$ brew install gotty
go get
Installation
If you have a Go language environment, you can install gotty with the go get
command.
$ go get github.com/yudai/gotty
Usage
Usage: gotty [options] <command> [<arguments...>]
Run gotty
with your preferred command as its arguments (e.g. gotty top
).
By default, gotty starts a web server at port 8080. Open the URL on your web browser and you can see the running command as if it's running on your terminal.
Options
--addr, -a IP address to listen [$GOTTY_ADDR]
--port, -p "8080" Port number to listen [$GOTTY_PORT]
--permit-write, -w Permit clients to write to the TTY (BE CAREFUL) [$GOTTY_PERMIT_WRITE]
--credential, -c Credential for Basic Authentication (ex: user:pass) [$GOTTY_CREDENTIAL]
By default, gotty doesn't allow clients to send any keystrokes or commands except terminal window resizing. When you want to permit clients to write input to the PTY, add the -w
option. However, accepting input from remote clients is dangerous for most commands. Make sure that only trusted clients can connect to your gotty server when you activate this option. If you need interaction with the PTY, consider starting gotty with tmux or GNU Screen and run your main command on it.
Sharing with Multiple Clients
Gotty starts a new process when a new client connects to the server. This means users cannot share a single terminal with others by default. However, you can use terminal multiplexers for sharing a single process with multiple clients.
For example, you can start a new tmux session named gotty
with top
command by the command below.
$ gotty tmux new -A -s gotty top
This command doesn't allow clients to send keystrokes, however, you can attach the session from your local terminal and run operations like switching the mode of the top
command. To connect to the tmux session from your terminal, you can use following command.
$ tmux new -A -s gotty
By using terminal multiplexers, you can have the control of your terminal and allow clients to just see your screen.
Quick Sharing on tmux
To share your current session with others by a shortcut key, you can add a line like below to your .tmux.conf
.
# Start gotty in a new window with C-t
bind-key C-t new-window "gotty tmux attach -t `tmux display -p '#S'`"
Playing with Docker
When you want to create a jailed environment for each client, you can use Docker containers like following:
$ gotty -w docker run -it --rm busybox
Development
You can build a binary yourself using following commands. Windows is not supported now.
# Install tools
go get github.com/jteeuwen/go-bindata/...
go get github.com/tools/godep
# Checkout hterm
git submodule sync && git submodule update --init --recursive
# Restore libraries in Godeps
godep restore
# Build
make
License
The MIT License