cmd

Documentation

Index

• Constants
• Variables
• func CheckOverriddenOrg()
• func Execute()
• func FormatVersion(version string, buildDate string, revision string) string
• func NewCmdAuth() *cobra.Command
• func NewCmdCompletion() *cobra.Command
• func NewCmdDiscover() *cobra.Command
• func NewCmdHistory() *cobra.Command
• func NewCmdRoot() *cobra.Command
• func NewCmdScan(rootCmd *cobra.Command) *cobra.Command
• func NewCmdUpdate() *cobra.Command
• func NewCmdVersion() *cobra.Command
• func NewCmdWorkflow() *cobra.Command
• func NewHelpTopic(topic string) *cobra.Command
• func SetDefautOrganization()
• type Choice
• type HistoryOptions
• type UpdateOptions
• type WorkflowOptions

Constants

const ClearPreviousLine = "\033[1A\033[K"

const ResetLine = "\r\033[K"

Variables

var HelpTopics = map[string]map[string]string{
	"environment": {
		"short": "Environment variables that can be used with reliably",

		"long": heredoc.Doc(`
			{{bold "RELIABLY_HOST:"}} specify the Reliably hostname for commands making API requests
			that would otherwise assume the "reliably.com" host.

			{{bold "RELIABLY_TOKEN:"}} an authentication token for reliably.com API requests. Setting
			this avoids to login and takes precedence over previously stored credentials.

			{{bold "RELIABLY_ORG:"}} an organization identifier for the active organization. Setting
			this takes precedence over previously stored current organization.

			{{bold "RELIABLY_NO_UPDATE_NOTIFIER:"}} set to any value to disable update notifications.
			By default, reliably checks for new releases once every 24 hours and displays
			an upgrade notice on standard error if a newer version was found.

			{{bold "NO_COLOR:"}} set to any value to avoid printing ANSI escape sequences for color
			output.

			{{bold "DEBUG:"}} set to any value to enable verbose output.
		`),
	},
}

Functions

func CheckOverriddenOrg

func CheckOverriddenOrg()

CheckOverriddenOrg sets into the loaded config the org info (ID & name) from the overridden RELIABLY_ORG env var that accepts either an org UIUD or an org slug/name

func Execute

func Execute()

Execute the root command and exit with nonzero code in case of errors

func FormatVersion

func FormatVersion(version string, buildDate string, revision string) string

FormatVersion returns a formatted string with Reliably CLI's version

func NewCmdAuth

func NewCmdAuth() *cobra.Command

func NewCmdCompletion

func NewCmdCompletion() *cobra.Command

func NewCmdDiscover

func NewCmdDiscover() *cobra.Command

func NewCmdHistory

func NewCmdHistory() *cobra.Command

func NewCmdRoot

func NewCmdRoot() *cobra.Command

func NewCmdScan

func NewCmdScan(rootCmd *cobra.Command) *cobra.Command

func NewCmdUpdate

func NewCmdUpdate() *cobra.Command

func NewCmdVersion

func NewCmdVersion() *cobra.Command

func NewCmdWorkflow

func NewCmdWorkflow() *cobra.Command

func NewHelpTopic

func NewHelpTopic(topic string) *cobra.Command

func SetDefautOrganization

func SetDefautOrganization()

SetDefautOrganization defines the user's default organization as the current active one, in case the RELIABLY_ORG has not been set and no organization is set in the config.

Types

type Choice

type Choice = cmdutil.Choice

type HistoryOptions

type HistoryOptions struct {
	IO         *iostreams.IOStreams
	Hostname   string
	HttpClient func() *http.Client

	History  *interface{}
	OrgID    string
	SourceID string
}

type UpdateOptions

type UpdateOptions struct {
	IO          *iostreams.IOStreams
	UpdaterRepo string

	Version   string
	NoConfirm bool
}

type WorkflowOptions

type WorkflowOptions struct {
	IO *iostreams.IOStreams

	Interactive bool
	Stdout      bool

	Platform string
}