config

package

v1.0.81 Latest Latest Go to latest Published: Apr 18, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/civo/cli

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func CivoAPIClient() (*civogo.Client, error)
func DefaultAPIKey() string
func ReadConfig()
func SaveConfig()
type Config
type Metadata

Constants ¶

This section is empty.

Variables ¶

View Source

var Filename string

Filename is set to a full filename if the default config file is overridden by a command-line switch

Functions ¶

func CivoAPIClient ¶

func CivoAPIClient() (*civogo.Client, error)

CivoAPIClient returns a civogo client using the current default API key

func DefaultAPIKey ¶

func DefaultAPIKey() string

DefaultAPIKey returns the current default API key

func ReadConfig ¶

func ReadConfig()

ReadConfig reads in config file and ENV variables if set.

func SaveConfig ¶

func SaveConfig()

SaveConfig saves the current configuration back out to a JSON file in either ~/.civo.json or Filename if one was set

Types ¶

type Config ¶

type Config struct {
	APIKeys          map[string]string         `json:"apikeys"`
	Meta             Metadata                  `json:"meta"`
	RegionToFeatures map[string]civogo.Feature `json:"region_to_features"`
}

Config describes the configuration for Civo's CLI

var Current Config

Current contains the parsed ~/.civo.json file

type Metadata ¶ added in v0.1.77

type Metadata struct {
	Admin              bool      `json:"admin"`
	CurrentAPIKey      string    `json:"current_apikey"`
	DefaultRegion      string    `json:"default_region"`
	LatestReleaseCheck time.Time `json:"latest_release_check"`
	URL                string    `json:"url"`
	LastCmdExecuted    time.Time `json:"last_command_executed"`
}

Metadata describes the metadata for Civo's CLI

Source Files ¶

View all Source files

config.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL