config

package
v0.19.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 10, 2025 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	ConfigFileName              = "config.yaml"
	DefaultAPIURL               = "https://console.cloud.timescale.com/public/api/v1"
	DefaultAnalytics            = true
	DefaultColor                = true
	DefaultConsoleURL           = "https://console.cloud.timescale.com"
	DefaultDebug                = false
	DefaultDocsMCP              = true
	DefaultDocsMCPURL           = "https://mcp.tigerdata.com/docs"
	DefaultGatewayURL           = "https://console.cloud.timescale.com/api"
	DefaultOutput               = "table"
	DefaultPasswordStorage      = "keyring"
	DefaultReleasesURL          = "https://cli.tigerdata.com"
	DefaultVersionCheckInterval = 24 * time.Hour
)

Variables

View Source 
var BuildTime = "unknown"
View Source 
var ErrNotLoggedIn = errors.New("not logged in")
View Source 
var GitCommit = "unknown"
View Source 
var Version = "dev"

These variables are set at build time via ldflags in the GoReleaser pipeline for production releases. Default values are used for local development builds.

Functions

func ApplyDefaults added in v0.8.0 

func ApplyDefaults(v *viper.Viper)

func ApplyEnvOverrides added in v0.8.0 

func ApplyEnvOverrides(v *viper.Viper)

func GetConfigDir 

func GetConfigDir() string

TODO: This function is currently used to get the directory that the API key fallback file should be stored in (see credentials.go). But ideally, those functions would take a Config struct and use the ConfigDir field instead.

func GetConfigFile 

func GetConfigFile(dir string) string

func GetCredentials added in v0.12.0 

func GetCredentials() (string, string, error)

GetCredentials retrieves the API key and project ID from storage Returns (apiKey, projectID, error) where apiKey is in "publicKey:secretKey" format

func GetDefaultConfigDir 

func GetDefaultConfigDir() string

func GetEffectiveConfigDir 

func GetEffectiveConfigDir(configDirFlag *pflag.Flag) string

func GetServiceName 

func GetServiceName() string

GetServiceName returns the appropriate service name for keyring operations

func ReadInConfig added in v0.8.0 

func ReadInConfig(v *viper.Viper) error

func RemoveCredentials added in v0.12.0 

func RemoveCredentials() error

RemoveCredentials removes stored credentials from keyring and file fallback

func ResetGlobalConfig 

func ResetGlobalConfig()

ResetGlobalConfig clears the global viper state for testing This is mainly used to reset viper configuration between test runs

func SetTestServiceName added in v0.7.1 

func SetTestServiceName(t *testing.T)

SetTestServiceName sets a unique service name for testing based on the test name This allows tests to use unique service names to avoid conflicts when running in parallel The cleanup is automatically registered with t.Cleanup()

func SetupViper 

func SetupViper(configDir string) error

SetupViper configures the global Viper instance with defaults, env vars, and config file

func StoreCredentials added in v0.12.0 

func StoreCredentials(apiKey, projectID string) error

StoreCredentials stores the API key (public:secret) and project ID together The credentials are stored as JSON with api_key and project_id fields

func StoreCredentialsToFile added in v0.12.0 

func StoreCredentialsToFile(apiKey, projectID string) error

StoreCredentialsToFile stores credentials to file (test helper)

func ValidConfigOptions added in v0.15.2 

func ValidConfigOptions() iter.Seq[string]

func ValidateOutputFormat added in v0.2.0 

func ValidateOutputFormat(format string, allowEnv bool) error

Types

type Config 

type Config struct {
	APIURL               string        `mapstructure:"api_url"`
	Analytics            bool          `mapstructure:"analytics"`
	Color                bool          `mapstructure:"color"`
	ConfigDir            string        `mapstructure:"config_dir"`
	ConsoleURL           string        `mapstructure:"console_url"`
	Debug                bool          `mapstructure:"debug"`
	DocsMCP              bool          `mapstructure:"docs_mcp"`
	DocsMCPURL           string        `mapstructure:"docs_mcp_url"`
	GatewayURL           string        `mapstructure:"gateway_url"`
	Output               string        `mapstructure:"output"`
	PasswordStorage      string        `mapstructure:"password_storage"`
	ReleasesURL          string        `mapstructure:"releases_url"`
	ServiceID            string        `mapstructure:"service_id"`
	VersionCheckInterval time.Duration `mapstructure:"version_check_interval"`
	VersionCheckLastTime time.Time     `mapstructure:"version_check_last_time"`
	// contains filtered or unexported fields
}

func FromViper added in v0.8.0 

func FromViper(v *viper.Viper) (*Config, error)

func Load 

func Load() (*Config, error)

Load creates a new Config instance from the current viper state This function should be called after SetupViper has been called to initialize viper

func UseTestConfig added in v0.5.1 

func UseTestConfig(configDir string, values map[string]any) (*Config, error)

UseTestConfig writes only the specified key-value pairs to the config file and returns a Config instance with those values set. This function is intended for testing purposes only, where you need to set up specific config file state without writing default values for unspecified keys.

func (*Config) EnsureConfigDir added in v0.8.0 

func (c *Config) EnsureConfigDir() (string, error)

func (*Config) GetConfigFile added in v0.5.1 

func (c *Config) GetConfigFile() string

func (*Config) Reset 

func (c *Config) Reset() error

func (*Config) Set 

func (c *Config) Set(key, value string) error

func (*Config) Unset 

func (c *Config) Unset(key string) error

func (*Config) UpdateField added in v0.12.0 

func (c *Config) UpdateField(key string, value any) (any, error)

UpdateField updates the field in the Config struct corresponding to the given key. It accepts either a string (from user input) or a typed value (string/bool from defaults). The function validates the value and updates both the struct field and viper state.

type ConfigOutput added in v0.8.0 

type ConfigOutput struct {
	APIURL               *string        `mapstructure:"api_url" json:"api_url,omitempty"`
	Analytics            *bool          `mapstructure:"analytics" json:"analytics,omitempty"`
	Color                *bool          `mapstructure:"color" json:"color,omitempty"`
	ConfigDir            *string        `mapstructure:"config_dir" json:"config_dir,omitempty"`
	ConsoleURL           *string        `mapstructure:"console_url" json:"console_url,omitempty"`
	Debug                *bool          `mapstructure:"debug" json:"debug,omitempty"`
	DocsMCP              *bool          `mapstructure:"docs_mcp" json:"docs_mcp,omitempty"`
	DocsMCPURL           *string        `mapstructure:"docs_mcp_url" json:"docs_mcp_url,omitempty"`
	GatewayURL           *string        `mapstructure:"gateway_url" json:"gateway_url,omitempty"`
	Output               *string        `mapstructure:"output" json:"output,omitempty"`
	PasswordStorage      *string        `mapstructure:"password_storage" json:"password_storage,omitempty"`
	ReleasesURL          *string        `mapstructure:"releases_url" json:"releases_url,omitempty"`
	ServiceID            *string        `mapstructure:"service_id" json:"service_id,omitempty"`
	VersionCheckInterval *util.Duration `mapstructure:"version_check_interval" json:"version_check_interval,omitempty"` // [util.Duration] ensures value is marshaled in [time.Duration.String] format when output
	VersionCheckLastTime *time.Time     `mapstructure:"version_check_last_time" json:"version_check_last_time,omitempty"`
}

func ForOutputFromViper added in v0.8.0 

func ForOutputFromViper(v *viper.Viper) (*ConfigOutput, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.