README
¶
Remote shell over gRPC
Like
sshorkubectl exec, but over gRPC.
This library contains code to run remote commands using the gRPC framework. Apart from the library, client and server CLIs are included.
Features:
- Execute shell commands or spawn an interactive shell on the server.
- Interactive PTY sessions are used to run the commands.
- Client is able to exit using the exit code of the remote command.
Usage
You'll need to have go > 1.18 installed.
-
Create the server
go run ./cmd/server -
Run the client
# Spawn interactive shell go run ./cmd/client # Run command go run ./cmd/client -- ping 1.1.1.1 -c 3
Server and client use 127.0.0.1:22222 for the connections by default.
Building
To compile server and client binaries, run:
make
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is the remote shell client.
func NewClientInsecure ¶
NewClientInsecure creates an insecure client.
func (*Client) Exec ¶
func (c *Client) Exec(opts *ExecOptions) (*int, error)
Exec executes a command in the server.
func (*Client) ExecContext ¶
ExecContext is like Exec, but with context.
type ExecOptions ¶
ExecOptions are the options for Exec.
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.