+0
Daily
19,561
stars
1,403
forks
317
watchers
119
prs
247
issues
16
releases
README
! GoTTY - Share your terminal as a web application
![GitHub release][release]
![Wercker][wercker]
![MIT License][license]
[release]: https://github.com/yudai/gotty/releases
[wercker]: https://app.wercker.com/project/bykey/03b91f441bebeda34f80e09a9f14126f
[license]: https://github.com/yudai/gotty/blob/master/LICENSE
GoTTY is a simple command line tool that turns your CLI tools into web applications.
!Screenshot
Installation
Download the latest stable binary file from the Releases page. Note that the release marked Pre-release is built for testing purpose, which can include unstable or breaking changes. Download a release marked Latest release for a stabale build.
(Files named with darwin_amd64 are for Mac OS X users)
Homebrew Installation
You can install GoTTY with Homebrew as well.
sh
$ brew install yudai/gotty/gotty
go get Installation (Development)
If you have a Go language environment, you can install GoTTY with the go get command. However, this command builds a binary file from the latest master branch, which can include unstable or breaking changes. GoTTY requires go1.9 or later.
sh
$ go get github.com/yudai/gotty
Usage
Usage: gotty [options] []
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 were running on your terminal.
Options
--address value, -a value IP address to listen (default: "0.0.0.0") [$GOTTY_ADDRESS]
--port value, -p value Port number to liten (default: "8080") [$GOTTY_PORT]
--permit-write, -w Permit clients to write to the TTY (BE CAREFUL) [$GOTTY_PERMIT_WRITE]
--credential value, -c value Credential for Basic Authentication (ex: user:pass, default disabled) [$GOTTY_CREDENTIAL]
--random-url, -r Add a random string to the URL [$GOTTY_RANDOM_URL]
--random-url-length value Random URL length (default: 8) [$GOTTY_RANDOM_URL_LENGTH]
--tls, -t Enable TLS/SSL [$GOTTY_TLS]
--tls-crt value TLS/SSL certificate file path (default: "~/.gotty.crt") [$GOTTY_TLS_CRT]
--tls-key value TLS/SSL key file path (default: "~/.gotty.key") [$GOTTY_TLS_KEY]
--tls-ca-crt value TLS/SSL CA certificate file for client certifications (default: "~/.gotty.ca.crt") [$GOTTY_TLS_CA_CRT]
--index value Custom index.html file [$GOTTY_INDEX]
--title-format value Title format of browser window (default: "{{ .command }}@{{ .hostname }}") [$GOTTY_TITLE_FORMAT]
--reconnect Enable reconnection [$GOTTY_RECONNECT]
--reconnect-time value Time to reconnect (default: 10) [$GOTTY_RECONNECT_TIME]
--max-connection value Maximum connection to gotty (default: 0) [$GOTTY_MAX_CONNECTION]
--once Accept only one client and exit on disconnection [$GOTTY_ONCE]
--timeout value Timeout seconds for waiting a client(0 toTop issues
#258Is this project is abandoned?9 comments · 2019-07-17#285Add Maintainers 7 comments · 2020-04-10#88Docker container won't exit by closing browser window5 comments · 2016-01-31#347The browser terminal cannot display emoji4 comments · 2023-01-06#331Installation through `go install` fails because of dependency issue4 comments · 2022-05-04#306Does not compile on ArchLinux4 comments · 2021-04-03#272Compilation fails with GO111MODULE=on4 comments · 2019-11-27#213Errors during installation (brew)4 comments · 2018-07-12
Latest release
Release v1.0.1 v1.0.1 2017-08-08This release is mainly for bug fixes. Fixes ----- 118: gotty.js clears browser's Local Storage 122: Configuration via environment variables doesn't work except GOTTY_CONFIGklllll 136: max-connections reporting wrong count