che-server/agents/exec/README.md

Summary

Golang based server for executing commands and streaming process output logs, also websocket-terminal.

Requirements

• golang 1.6+

Docs

• jsonrpc2.0 based Webscoket API
• jsonrpc2.0 based Events
• REST API

Development

Link the sources to standard go workspace

export CHE_PATH=~/code/che
mkdir $GOPATH/src/github.com/eclipse/che/agents -p
ln -s $CHE_PATH/agents/exec/src $GOPATH/src/github.com/eclipse/che/agents/exec

Install godep

go get github.com/tools/godep

Get all dependencies

cd $GOPATH/src/github.com/eclipse/che/agents/exec
$GOPATH/bin/godep restore

That's it, $GOPATH/src/github.com/eclipse/che/agents/exec project is ready.

Building linked project

cd $GOPATH/src/github.com/eclipse/che/agents/exec && go build

Running linked project tests

cd $GOPATH/src/github.com/eclipse/che/agents/exec && go test ./...

Formatting linked project sources

cd $GOPATH/src/github.com/eclipse/che/agents/exec && go fmt ./...