cli

Documentation

Index

• Variables
• func MarshalConfig(c *Config) ([]byte, error)
• func NewRootCommand(cli *CLI) *cobra.Command
• func UnmarshalConfig(config *Config, data []byte) error
• type CLI
  • func NewCLI() *CLI
  • func (c *CLI) ActionProgress(ctx context.Context, action *hcloud.Action) error
  • func (c *CLI) CertificateLabelKeys(idOrName string) []string
  • func (c *CLI) CertificateNames() []string
  • func (c *CLI) Client() *hcloud.Client
  • func (c *CLI) DataCenterNames() []string
  • func (c *CLI) FloatingIPLabelKeys(idOrName string) []string
  • func (c *CLI) FloatingIPNames() []string
  • func (c *CLI) ISONames() []string
  • func (c *CLI) ImageLabelKeys(idOrName string) []string
  • func (c *CLI) ImageNames() []string
  • func (c *CLI) LoadBalancerLabelKeys(idOrName string) []string
  • func (c *CLI) LoadBalancerNames() []string
  • func (c *CLI) LoadBalancerTypeNames() []string
  • func (c *CLI) LocationNames() []string
  • func (c *CLI) NetworkLabelKeys(idOrName string) []string
  • func (c *CLI) NetworkName(id int) string
  • func (c *CLI) NetworkNames() []string
  • func (c *CLI) ReadConfig() error
  • func (c *CLI) ReadEnv()
  • func (c *CLI) SSHKeyLabelKeys(idOrName string) []string
  • func (c *CLI) SSHKeyNames() []string
  • func (c *CLI) ServerLabelKeys(idOrName string) []string
  • func (c *CLI) ServerName(id int) string
  • func (c *CLI) ServerNames() []string
  • func (c *CLI) ServerTypeNames() []string
  • func (c *CLI) Terminal() bool
  • func (c *CLI) VolumeLabelKeys(idOrName string) []string
  • func (c *CLI) VolumeNames() []string
  • func (c *CLI) WaitForActions(ctx context.Context, actions []*hcloud.Action) error
  • func (c *CLI) WriteConfig() error
• type Config
  • func (config *Config) ContextByName(name string) *ConfigContext
  • func (config *Config) ContextNames() []string
  • func (config *Config) RemoveContext(context *ConfigContext)
• type ConfigContext
• type ContextPresentation
• type RawConfig
• type RawConfigContext

Variables

var DefaultConfigPath string

var ErrConfigPathUnknown = errors.New("config file path unknown")

var Version = "was not built properly"

Version is set via compiler flags (see script/build.bash)

Functions

func MarshalConfig

func MarshalConfig(c *Config) ([]byte, error)

func NewRootCommand

func NewRootCommand(cli *CLI) *cobra.Command

func UnmarshalConfig

func UnmarshalConfig(config *Config, data []byte) error

Types

type CLI

type CLI struct {
	Token         string
	Endpoint      string
	Context       context.Context
	Config        *Config
	ConfigPath    string
	Debug         bool
	DebugFilePath string

	RootCommand *cobra.Command
	// contains filtered or unexported fields
}

func NewCLI

func NewCLI() *CLI

func (*CLI) ActionProgress

func (c *CLI) ActionProgress(ctx context.Context, action *hcloud.Action) error

func (*CLI) CertificateLabelKeys

func (c *CLI) CertificateLabelKeys(idOrName string) []string

func (*CLI) CertificateNames

func (c *CLI) CertificateNames() []string

func (*CLI) Client

func (c *CLI) Client() *hcloud.Client

func (*CLI) DataCenterNames

func (c *CLI) DataCenterNames() []string

func (*CLI) FloatingIPLabelKeys

func (c *CLI) FloatingIPLabelKeys(idOrName string) []string

func (*CLI) FloatingIPNames

func (c *CLI) FloatingIPNames() []string

func (*CLI) ISONames

func (c *CLI) ISONames() []string

func (*CLI) ImageLabelKeys

func (c *CLI) ImageLabelKeys(idOrName string) []string

func (*CLI) ImageNames

func (c *CLI) ImageNames() []string

func (*CLI) LoadBalancerLabelKeys

func (c *CLI) LoadBalancerLabelKeys(idOrName string) []string

func (*CLI) LoadBalancerNames

func (c *CLI) LoadBalancerNames() []string

func (*CLI) LoadBalancerTypeNames

func (c *CLI) LoadBalancerTypeNames() []string

func (*CLI) LocationNames

func (c *CLI) LocationNames() []string

func (*CLI) NetworkLabelKeys

func (c *CLI) NetworkLabelKeys(idOrName string) []string

func (*CLI) NetworkName

func (c *CLI) NetworkName(id int) string

func (*CLI) NetworkNames

func (c *CLI) NetworkNames() []string

func (*CLI) ReadConfig

func (c *CLI) ReadConfig() error

func (*CLI) ReadEnv

func (c *CLI) ReadEnv()

func (*CLI) SSHKeyLabelKeys

func (c *CLI) SSHKeyLabelKeys(idOrName string) []string

func (*CLI) SSHKeyNames

func (c *CLI) SSHKeyNames() []string

func (*CLI) ServerLabelKeys

func (c *CLI) ServerLabelKeys(idOrName string) []string

func (*CLI) ServerName

func (c *CLI) ServerName(id int) string

func (*CLI) ServerNames

func (c *CLI) ServerNames() []string

func (*CLI) ServerTypeNames

func (c *CLI) ServerTypeNames() []string

func (*CLI) Terminal

func (c *CLI) Terminal() bool

Terminal returns whether the CLI is run in a terminal.

func (*CLI) VolumeLabelKeys

func (c *CLI) VolumeLabelKeys(idOrName string) []string

func (*CLI) VolumeNames

func (c *CLI) VolumeNames() []string

func (*CLI) WaitForActions

func (c *CLI) WaitForActions(ctx context.Context, actions []*hcloud.Action) error

func (*CLI) WriteConfig

func (c *CLI) WriteConfig() error

type Config

type Config struct {
	Endpoint      string
	ActiveContext *ConfigContext
	Contexts      []*ConfigContext
}

func (*Config) ContextByName

func (config *Config) ContextByName(name string) *ConfigContext

func (*Config) ContextNames

func (config *Config) ContextNames() []string

func (*Config) RemoveContext

func (config *Config) RemoveContext(context *ConfigContext)

type ConfigContext

type ConfigContext struct {
	Name  string
	Token string
}

type ContextPresentation

type ContextPresentation struct {
	Name   string
	Token  string
	Active string
}

type RawConfig

type RawConfig struct {
	ActiveContext string             `toml:"active_context,omitempty"`
	Contexts      []RawConfigContext `toml:"contexts"`
}

type RawConfigContext

type RawConfigContext struct {
	Name  string `toml:"name"`
	Token string `toml:"token"`
}