cli

Documentation

Overview

Package cli provides a client SDK for outputting data to a terminal in multiple formats

Index

• Constants
• func FetchAndOutput(f func() (models.TabbyPrinter, error)) error
• type CLIClient
  • func New(client *http.Client, host, key string, port int, protocol, outputStyle string) (*CLIClient, error)
  • func NewFromViper(client *http.Client) (*CLIClient, error)
  • func (c *CLIClient) FetchAndOutput(f func() (apiresponse.TabbyPrinter, error)) error
  • func (c *CLIClient) OutputObject(tabby_printer apiresponse.TabbyPrinter) error
  • func (c *CLIClient) PromptForAttribute() (models.Attribute, error)
• type Client
  • func NewCliClient(outputStyle string) (*Client, error)
  • func NewCliClientFromViper() (*Client, error)
  • func (c *Client) OutputObject(tabby_printer models.TabbyPrinter) error
  • func (c Client) PromptForAttribute(apiClient *api.ApiClient) (models.Attribute, error)

Constants

const (
	OutputStyleJSON       = "json"
	OutputStyleJSONPretty = "json_pretty"
	OutputStyleTabby      = "tabby" // Default
)

Functions

func FetchAndOutput

func FetchAndOutput(f func() (models.TabbyPrinter, error)) error

Deprecated: Use (*CLIClient).FetchAndOutput instead

Types

type CLIClient

type CLIClient struct {
	APIClient    *apiclient.APIClient
	OutputStyle  string
	TabbyHeaders []string
}

func New

func New(client *http.Client, host, key string, port int, protocol, outputStyle string) (*CLIClient, error)

func NewFromViper

func NewFromViper(client *http.Client) (*CLIClient, error)

func (*CLIClient) FetchAndOutput

func (c *CLIClient) FetchAndOutput(f func() (apiresponse.TabbyPrinter, error)) error

func (*CLIClient) OutputObject

func (c *CLIClient) OutputObject(tabby_printer apiresponse.TabbyPrinter) error

OutputObject prints indented or unindented json, or an ascii table (tabby) (depending on *CLIClient#OutputStyle) to stdout

func (*CLIClient) PromptForAttribute

func (c *CLIClient) PromptForAttribute() (models.Attribute, error)

type Client

type Client struct {
	TabbyHeaders []string // e.g. ["id", "name"]
}

Deprecated: Use CLIClient instead

func NewCliClient

func NewCliClient(outputStyle string) (*Client, error)

Deprecated: Use New instead

func NewCliClientFromViper

func NewCliClientFromViper() (*Client, error)

Deprecated: Use NewFromViper instead

func (*Client) OutputObject

func (c *Client) OutputObject(tabby_printer models.TabbyPrinter) error

Deprecated: Use (*CLIClient).OutputObject instead

OutputObject prints indented or unindented json, or an ascii table (tabby) (depending on *Client#OutputStyle) to stdout

func (Client) PromptForAttribute

func (c Client) PromptForAttribute(apiClient *api.ApiClient) (models.Attribute, error)

Deprecated: Use (*CLIClient).PromptForAttribute instead