config

Documentation

Index

• type CommandLineGlobals
  • func NewCommandLineGlobals() CommandLineGlobals
  • func (g *CommandLineGlobals) RequireAPIAccess() error

Types

type CommandLineGlobals

type CommandLineGlobals struct {
	// CacheDir is user local directory used to store temporary data.
	CacheDir string

	// Verbosity is the user's preference for logging output.
	Verbosity int

	NS1APIBaseURL string
	NS1APIKey     string
}

CommandLineGlobals are options that apply to all/most commands. These are set on the root command level.

func NewCommandLineGlobals

func NewCommandLineGlobals() CommandLineGlobals

NewCommandLineGlobals creates a new globals with some defaults.

func (*CommandLineGlobals) RequireAPIAccess

func (g *CommandLineGlobals) RequireAPIAccess() error

RequireAPIAccess validates that global parameters are set appropriately for REST API access.