config

package

v0.1.0 Latest Latest Go to latest Published: Apr 14, 2024 License: GPL-3.0 Imports: 10 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

This section is empty.

This section is empty.

func ConfigDir() (string, error)

func ConfigFile() (string, error)

func DefaultConfigRoot() *yaml.Node

func WriteConfigFile(filename string, data []byte) error

type Config interface {
	Write() error
	Machines() *MachinesConfig
	Keys() *KeysConfig
	Email() string
	SetEmail(email string) error
}

func NewConfig(documentNode *yaml.Node) Config

func ParseDefaultConfig() (Config, error)

type KeyEntry struct {
	Name       string
	Private    string
	Public     string
	Passphrase string
	CreatedAt  time.Time
}

type KeysConfig struct {
	Node   *yaml.Node
	Parent Config
}

func (c *KeysConfig) Add(entry KeyEntry) error

func (c *KeysConfig) All() []KeyEntry

func (c *KeysConfig) GetByName(name string) (KeyEntry, error)

func (c *KeysConfig) Remove(name string) error

type MachineEntry struct {
	Name      string
	Host      net.IP
	User      string
	Key       string
	CreatedAt time.Time
}

type MachinesConfig struct {
	Node   *yaml.Node
	Parent Config
}

func (c *MachinesConfig) Add(entry MachineEntry) error

func (c *MachinesConfig) All() []MachineEntry

func (c *MachinesConfig) GetByNameOrHost(nameOrHost string) *MachineEntry

func (c *MachinesConfig) Remove(nameOrHost string) error