config

package

v0.1.8 Latest Latest Go to latest Published: Apr 18, 2019 License: Apache-2.0 Imports: 7 Imported by: 5

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/openshift-online/ocm-cli

Links

Open Source Insights

Documentation ¶

Index ¶

func Armed(cfg *Config) (armed bool, err error)
func Location() (path string, err error)
func Remove() error
func Save(cfg *Config) error
type Config
- func Load() (cfg *Config, err error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Armed ¶

func Armed(cfg *Config) (armed bool, err error)

Armed checks if the configuration contains either credentials or tokens that haven't expired, so that it can be used to perform authenticated requests.

func Location ¶

func Location() (path string, err error)

Location returns the location of the configuration file.

func Remove ¶

func Remove() error

Remove removes the configuration file.

func Save ¶

func Save(cfg *Config) error

Save saves the given configuration to the configuration file.

Types ¶

type Config ¶

type Config struct {
	AccessToken  string   `json:"access_token,omitempty"`
	ClientID     string   `json:"client_id,omitempty"`
	ClientSecret string   `json:"client_secret,omitempty"`
	Insecure     bool     `json:"insecure,omitempty"`
	Password     string   `json:"password,omitempty"`
	RefreshToken string   `json:"refresh_token,omitempty"`
	Scopes       []string `json:"scopes,omitempty"`
	Token        string   `json:"token,omitempty"`
	TokenURL     string   `json:"token_url,omitempty"`
	URL          string   `json:"url,omitempty"`
	User         string   `json:"user,omitempty"`
}

Config is the type used to store the configuration of the client.

func Load ¶

func Load() (cfg *Config, err error)

Load loads the configuration from the configuration file. If the configuration file doesn't exist it will return an empty configuration object.

Source Files ¶

View all Source files

config.go

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