config

Documentation

Index

• Constants
• Variables
• func BindPFlags(cmd *cobra.Command, _ []string)
• func InitConfig()
• func LoadApiCredentialsFile()
• func LoadConfigFile(output any, filename string) (bool, error)
• func MarkValidFlagCombinations(cmd *cobra.Command, favoriteFlagCombination []string, ...)
• func OtterizeConfigDirPath() (string, error)
• func RegisterStringArg(cmd *cobra.Command, configKey string, usage string, required bool)
• func RegisterStringArgShorthand(cmd *cobra.Command, configKey string, usage string, required bool, ...)
• func RegisterStringArgShorthandWithDefault(cmd *cobra.Command, configKey string, usage string, required bool, ...)
• func RegisterStringArgWithDefault(cmd *cobra.Command, configKey string, usage string, required bool, ...)
• func SaveConfig(conf Config) error
• func SaveJSONConfig(config any, filename string) error
• func ValidateFlagCombination(cmd *cobra.Command) error
• type Config
• type MissingFlagsError
  • func (m MissingFlagsError) Error() string

Constants

const ApiClientIdKey = "client-id"

const ApiClientSecretKey = "client-secret"

const ApiCredentialsFilename = "credentials"

const ApiSelectedOrganizationId = "org-id"

const ApiUserTokenExpiryKey = "token-expiry"

const ApiUserTokenKey = "token"

const DebugDefault = false

const DebugKey = "debug"

const DefaultTimeout = 60 * time.Second

const EnvPrefix = "OTTERIZE"

const InteractiveModeKey = "interactive"

const OtterizeAPIAddressDefault = "https://app.otterize.com/api"

const OtterizeAPIAddressKey = "api-address"

const OtterizeConfigDirName = ".otterize"

const OtterizeConfigFileName = "config"

const OutputDefault = OutputText

const OutputJson = "json"

const OutputKey = "output"

const OutputText = "text"

const OutputYaml = "yaml"

const QuietModeDefault = false

const QuietModeKey = "quiet"

const QuietModeShorthand = "q"

Variables

var CfgFile string // used for flag

Functions

func BindPFlags

func BindPFlags(cmd *cobra.Command, _ []string)

func InitConfig

func InitConfig()

func LoadApiCredentialsFile

func LoadApiCredentialsFile()

func LoadConfigFile

func LoadConfigFile(output any, filename string) (bool, error)

func MarkValidFlagCombinations

func MarkValidFlagCombinations(cmd *cobra.Command, favoriteFlagCombination []string, validFlagCombinations ...[]string)

func OtterizeConfigDirPath

func OtterizeConfigDirPath() (string, error)

func RegisterStringArg

func RegisterStringArg(cmd *cobra.Command, configKey string, usage string, required bool)

func RegisterStringArgShorthand

func RegisterStringArgShorthand(cmd *cobra.Command, configKey string, usage string, required bool, shorthand string)

func RegisterStringArgShorthandWithDefault

func RegisterStringArgShorthandWithDefault(cmd *cobra.Command, configKey string, usage string, required bool, defaultValue string, shorthand string)

func RegisterStringArgWithDefault

func RegisterStringArgWithDefault(cmd *cobra.Command, configKey string, usage string, required bool, defaultValue string)

func SaveConfig

func SaveConfig(conf Config) error

func SaveJSONConfig

func SaveJSONConfig(config any, filename string) error

func ValidateFlagCombination

func ValidateFlagCombination(cmd *cobra.Command) error

Types

type Config

type Config struct {
	ClientId       string    `json:"client_id,omitempty"`
	ClientSecret   string    `json:"client_secret,omitempty"`
	UserToken      string    `json:"user_token,omitempty"`
	Expiry         time.Time `json:"expiry,omitempty"`
	OrganizationId string    `json:"organization_id"`
}

type MissingFlagsError

type MissingFlagsError struct {
	MissingFlagsOptions [][]string
	Err                 string
}

func (MissingFlagsError) Error

func (m MissingFlagsError) Error() string