clicontext

Documentation

Index

• type Config
  • func LoadPath(path string) (*Config, error)
  • func (c *Config) WriteTo(w io.Writer) (int64, error)
• type Option
  • func WithDir(d string) Option
  • func WithNoSymlink() Option
• type Storage
  • func NewStorage(opts ...Option) (*Storage, error)
  • func TestStorage(t testing.T) *Storage
  • func (m *Storage) Default() (string, error)
  • func (m *Storage) Delete(n string) error
  • func (m *Storage) List() ([]string, error)
  • func (m *Storage) Load(n string) (*Config, error)
  • func (m *Storage) Rename(from, to string) error
  • func (m *Storage) Set(n string, c *Config) error
  • func (m *Storage) SetDefault(n string) error
  • func (m *Storage) UnsetDefault() error

Types

type Config

type Config struct {
	// Server is the configuration to talk to a Waypoint server.
	Server serverconfig.Client `hcl:"server,block"`
}

Config is the structure of the context configuration file. This structure can be decoded with hclsimple.DecodeFile.

func LoadPath

func LoadPath(path string) (*Config, error)

LoadPath loads a context configuration from a filepath.

func (*Config) WriteTo

func (c *Config) WriteTo(w io.Writer) (int64, error)

WriteTo implements io.WriterTo and encodes this config as HCL.

type Option

type Option func(*Storage) error

func WithDir

func WithDir(d string) Option

WithDir specifies the directory where context configuration will be stored. This doesn't have to exist already but we must have permission to create it.

func WithNoSymlink

func WithNoSymlink() Option

WithNoSymlink disables all symlink usage in the Storage. If symlinks were used previously then they'll still work.

type Storage

type Storage struct {
	// contains filtered or unexported fields
}

Storage is the primary struct for interacting with stored CLI contexts. Contexts are always stored directly on disk with one set as the default.

func NewStorage

func NewStorage(opts ...Option) (*Storage, error)

NewStorage initializes context storage.

func TestStorage

func TestStorage(t testing.T) *Storage

TestStorage returns a *Storage pointed at a temporary directory. This will cleanup automatically by using t.Cleanup.

func (*Storage) Default

func (m *Storage) Default() (string, error)

Default returns the name of the default context.

func (*Storage) Delete

func (m *Storage) Delete(n string) error

Delete deletes the context with the given name.

func (*Storage) List

func (m *Storage) List() ([]string, error)

List lists the contexts that are available.

func (*Storage) Load

func (m *Storage) Load(n string) (*Config, error)

Load loads a context with the given name.

func (*Storage) Rename

func (m *Storage) Rename(from, to string) error

Rename renames a context. This will error if the "from" context does not exist. If "from" is the default context then the default will be switched to "to". If "to" already exists, this will overwrite it.

func (*Storage) Set

func (m *Storage) Set(n string, c *Config) error

Set will set a new configuration with the given name. This will overwrite any existing context of this name.

func (*Storage) SetDefault

func (m *Storage) SetDefault(n string) error

SetDefault sets the default context to use. If the given context doesn't exist, an os.IsNotExist error will be returned.

func (*Storage) UnsetDefault

func (m *Storage) UnsetDefault() error

UnsetDefault unsets the default context.