gottyclient

README

gotty-client

🔧 GoTTY client for your terminal

                +----------------+       +----------------+      +-------------+
                |                |       |             +--------->  /bin/bash  |
            +--->    Browser    -----+   |     gotty   |  |      +-------------+
+-------+   |   |                |   |   |             |  |                     
|       |   |   +----------------+   |   |             |  |      +-------------+
|  Bob  +---+                        +--->---websockets+--------->  /bin/bash  |
|       |   |   +================+   |   |             |  |      +-------------+
+-------+   |   |................|   |   |             |  |                     
            +--->..gotty-client.-----+   |             |  |      +-------------+
                |................|       |             +--------->  /bin/bash  |
                +================+       +----------------+      +-------------+

                  ^  ^  ^  ^  ^
                  |  |  |  |  |

Install

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

Usage

Server side

$ 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:31 URL: http://127.0.0.1:9191/
2015/08/24 18:54:31 URL: http://[fe80::1]:9191/
2015/08/24 18:54:31 URL: http://[fe80::ee35:86ff:fe4c:cf5c]:9191/
2015/08/24 18:54:31 URL: http://192.168.86.131:9191/
2015/08/24 18:54:31 URL: http://[2a01:e35:2435:3b00:ee35:86ff:fe4c:cf5c]:9191/
2015/08/24 18:54:31 URL: http://[2a01:e35:2435:3b00:6563:e6a2:dbab:5ade]:9191/
2015/08/24 18:54:31 URL: http://[fe80::a895:4fff:fef2:d4c7]:9191/
2015/08/24 18:54:31 URL: http://[fe80::4882:98b5:853c:15be]:9191/
2015/08/24 18:54:31 URL: http://[fd87:46a0:dbdf:90bb:4882:98b5:853c:15be]:9191/
2015/08/24 18:54:31 URL: http://[fe80::8bf9:b113:3444:98b4]:9191/
2015/08/24 18:54:31 URL: http://192.168.2.1:9191/
2015/08/24 18:54:31 URL: http://[fe80::10dd:b1ff:fe2c:7764]:9191/
2015/08/24 18:54:31 URL: http://172.16.252.11:9191/
2015/08/24 18:54:31 URL: http://192.168.99.1:9191/
2015/08/24 18:54:31 URL: http://[fe80::7bfb:c14b:2534:3bc5]:9191/
2015/08/24 18:54:31 URL: http://[fe80::34a3:95ff:fec7:97d5]:9191/
2015/08/24 18:54:31 URL: http://172.20.10.2: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

License

MIT

Documentation

Index

• func GetAuthTokenURL(httpURL string) (*url.URL, *http.Header, error)
• func GetWebsocketURL(httpURL string) (*url.URL, *http.Header, error)
• type Client
  • func NewClient(httpURL string) (*Client, error)
  • func (c *Client) Close()
  • func (c *Client) Connect() error
  • func (c *Client) GetAuthToken() (string, error)
  • func (c *Client) Loop() error

Functions

func GetAuthTokenURL

func GetAuthTokenURL(httpURL string) (*url.URL, *http.Header, error)

GetAuthTokenURL transforms a GoTTY http URL to its AuthToken file URL

func GetWebsocketURL

func GetWebsocketURL(httpURL string) (*url.URL, *http.Header, error)

GetWebsocketURL transforms a GoTTY http URL to its WebSocket URL

Types

type Client

type Client struct {
	Dialer    *websocket.Dialer
	Conn      *websocket.Conn
	URL       string
	Connected bool
}

func NewClient

func NewClient(httpURL string) (*Client, error)

NewClient returns a GoTTY client object

func (*Client) Close

func (c *Client) Close()

Close will nicely close the dialer

func (*Client) Connect

func (c *Client) Connect() error

Connect tries to dial a websocket server

func (*Client) GetAuthToken

func (c *Client) GetAuthToken() (string, error)

GetAuthToken retrieves an Auth Token from dynamic auth_token.js file

func (*Client) Loop

func (c *Client) Loop() error

Loop will look indefinitely for new messages