ttrpcurl

README

ttRPCurl

ttrpcurl is a command-line tool that lets you interact with ttRPC servers. It's basically curl for ttRPC servers, and is heavily influenced by gRPCurl, which does the same thing for gRPC.

[!NOTE]
This project is still in development. Please open an issue if anything doesn't work out for you.

Installation

Install via the Go command:

go install github.com/katexochen/ttrpcurl/cmd/ttrpcurl@latest

Usage

The CLI comes with help flags, both global and on each command:

ttrpcurl --help
ttrpcurl <command> --help

Syntax compatibility with gRPCurl

This tool tries to provide intuitive usability for people familiar with grpcurl. However, as ttrpcurl isn't using Go's native flag package there are some differences. Flags in ttrpcurl require two dashes (--help).

TODOs

• Improve client-server testscript
• Support multiple proto files
• Write unit tests
• Write e2e tests
• Support streaming calls
• Support bidirectional streaming calls
• Support data from file with @filename
• Support protobuf text format
• Use timeout and other limits

Limitations

Documentation

Index

• type Client
  • func NewClient(conn net.Conn, source *proto.Source, marsh proto.Marshaler) *Client
  • func (c *Client) Call(ctx context.Context, method string, reqBytes []byte) error

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(conn net.Conn, source *proto.Source, marsh proto.Marshaler) *Client

func (*Client) Call

func (c *Client) Call(ctx context.Context, method string, reqBytes []byte) error