cmd

Documentation

Overview

Package cmd is a tiny package that contains common data types shared between the main rsc command line parser and the API client command line tools.

Index

• type CommandClient
• type CommandLine

Types

type CommandClient

type CommandClient interface {
	ShowCommandHelp(cmdLine string) error              // Show contextual help
	ShowAPIActions(cmdLine string) error               // Print API or resource actions
	RunCommand(cmdLine string) (*http.Response, error) // Run command
}

CommandClient is the common interface between rsc package and API client packages. Provide methods to show help about and run commands.

type CommandLine

type CommandLine struct {
	Command             string // Command to be run (e.g. "api15 index")
	ConfigPath          string // Path to rsc config file, defaults to $HOME/.rsc
	JSONSelect          string // jsonselect expression for json subcommand
	Account             int    // RightScale account, optional
	Host                string // API hostname, optional
	OAuthToken          string // Auth refresh token, alternative to Username+Password, OAuthAccessToken, APIToken or RL10
	OAuthAccessToken    string // Auth access token, alternative to Username+Password, OAuthToken, APIToken or RL10
	APIToken            string // Instance API token, alternative to Username+Password, OAuthToken or RL10
	Username            string // Login username, alternative to OAuthToken, APIToken or RL10
	Password            string // Login pasword, alternative to OAuthToken, APIToken or RL10
	RL10                bool   // Whether to send requests using the RL10 proxy
	NoAuth              bool   // Whether to send requests unauthenticated
	FetchResource       bool   // Whether to fetch resource returned in 'Location' header
	ExtractOneSelect    string // JSON select expression to extract single value from response, optional
	ExtractSelector     string // JSON select expression to extract zero or more values from response, optional
	ExtractSelectorJSON string // JSON select expression to extract zero or more values from response, extracted values are displayed using JSON encoding, optional
	ExtractHeader       string // Name of header to extract from response, optional
	Dump                string // Whether to dump raw HTTP request and response to stdout (values are empty string - don't dump, "debug" or "json")
	Verbose             bool   // Whether to dump auth requests and sensitive headers
	Pretty              bool   // Whether to display response body or extract values using pretty printer
	Timeout             int    // Request timeout in seconds
	ShowHelp            bool   // Whether to show help for action flags
	Retry               int    //  Number of retry attempts for non-successful API responses (500, 503, and timeouts only)
}

CommandLine contains the command name and top level flags. API clients register additional sub-commands with their own flags This data structure is created by rsc and given to each API client command line tool for processing.