terraform/vendor/github.com/moul/gotty-client/README.md

8.4 KiB

gotty-client

🔧 Terminal client for GoTTY.

Build Status GoDoc

                                                             ┌─────────────────┐
                                                     ┌──────▶│    /bin/bash    
                                                            └─────────────────┘
                ┌──────────────┐               ┌──────────┐
                                               Gotty   
┌───────┐   ┌──▶│   Browser    │───────┐                 
                                                   
             └──────────────┘                          ┌─────────────────┐
  Bob  │───┤                      websockets─▶│          │─▶│ emacs /var/www  
             ╔═ ══ ══ ══ ══                           └─────────────────┘
                                                   
└───────┘   └──▶║ gotty-client  ───────┘                 
                                                        
                ╚═ ══ ══ ══ ══                └──────────┘
                                                            ┌─────────────────┐
                                                     └──────▶│   tmux attach   
                                                             └─────────────────┘

Example

Server side (GoTTY)

$ gotty -p 9191 sh -c 'while true; do date; sleep 1; done'
2015/08/24 18:54:31 Server is starting with command: sh -c while true; do date; sleep 1; done
2015/08/24 18:54:31 URL: http://[::1]:9191/
2015/08/24 18:54:34 GET /ws
2015/08/24 18:54:34 New client connected: 127.0.0.1:61811
2015/08/24 18:54:34 Command is running for client 127.0.0.1:61811 with PID 64834
2015/08/24 18:54:39 Command exited for: 127.0.0.1:61811
2015/08/24 18:54:39 Connection closed: 127.0.0.1:61811
...

Client side

$ gotty-client http://localhost:9191/
INFO[0000] New title: GoTTY - sh -c while true; do date; sleep 1; done (jean-michel-van-damme.local)
WARN[0000] Unhandled protocol message: json pref: 2{}
Mon Aug 24 18:54:34 CEST 2015
Mon Aug 24 18:54:35 CEST 2015
Mon Aug 24 18:54:36 CEST 2015
Mon Aug 24 18:54:37 CEST 2015
Mon Aug 24 18:54:38 CEST 2015
^C

Usage

$ gotty-client -h
NAME:
   gotty-client - GoTTY client for your terminal

USAGE:
   gotty-client [global options] command [command options] GOTTY_URL

VERSION:
   1.3.0+

AUTHOR(S):
   Manfred Touron <https://github.com/moul/gotty-client>

COMMANDS:
   help, h	Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --debug, -D		Enable debug mode [$GOTTY_CLIENT_DEBUG]
   --help, -h		show help
   --version, -v	print the version

Install

Install latest version using Golang (recommended)

$ go get github.com/moul/gotty-client/cmd/gotty-client

Install latest version using Homebrew (Mac OS X)

$ brew install https://raw.githubusercontent.com/moul/gotty-client/master/contrib/homebrew/gotty-client.rb --HEAD

or the latest released version

$ brew install https://raw.githubusercontent.com/moul/gotty-client/master/contrib/homebrew/gotty-client.rb

Changelog

master (unreleased)

  • No entry

full commits list

v1.6.1 (2017-01-19)

full commits list

v1.6.0 (2016-05-23)

  • Support of --use-proxy-from-env (Add Proxy support) (#36) (@byung2)
  • Add debug mode (#18)
  • Fix argument passing (#16)
  • Remove warnings + golang fixes and refactoring (@QuentinPerez)

full commits list

v1.5.0 (2016-02-18)

  • Add autocomplete support (#19)
  • Switch from Party to Godep
  • Fix terminal data being interpreted as format string (#34) (@mickael9)

full commits list

v1.4.0 (2015-12-09)

  • Remove solaris,plan9,nacl for .goxc.json
  • Add an error if the go version is lower than 1.5
  • Flexible parsing of the input URL
  • Add tests
  • Support of --skip-tls-verify

full commits list

v1.3.0 (2015-10-27)

  • Fix connected state when using Connect() + Loop() methods
  • Add ExitLoop which allow to exit from Loop function

full commits list

v1.2.0 (2015-10-23)

  • Removed an annoying warning when exiting connection (#22) (@QuentinPerez)
  • Add the ability to configure alternative stdout (#21) (@QuentinPerez)
  • Refactored the goroutine system with select, improve speed and stability (@QuentinPerez)
  • Add debug mode (--debug/-D) (#18)
  • Improve error message when connecting by checking HTTP status code
  • Fix arguments passing (#16)
  • Dropped support for golang<1.5
  • Small fixes

full commits list

v1.1.0 (2015-10-10)

  • Handling arguments + using mutexes (thanks to @QuentinPerez)
  • Add logo (#9)
  • Using codegansta/cli for CLI parsing (#3)
  • Fix panic when running on older GoTTY server (#13)
  • Add 'homebrew support' (#1)
  • Add Changelog (#5)
  • Add GOXC configuration to build binaries for multiple architectures (#2)

full commits list

v1.0.1 (2015-09-27)

  • Using party to manage dependencies

full commits list

v1.0.0 (2015-09-27)

Compatible with GoTTY version: v0.0.10

Features

  • Support basic-auth
  • Support terminal-(re)size
  • Support write
  • Support title
  • Support custom URI

full commits list

License

MIT