dev

Documentation

Index

• type Config
  • func DefaultConfig() *Config
  • func (c *Config) LoadFromFile(path string) (*Config, error)
  • func (c *Config) Merge(b *Config) *Config
  • func (c *Config) Validate() error
• type Dev
  • func New(config *Config, logger log.Logger) (*Dev, error)
  • func (d *Dev) Destroy() error
  • func (d *Dev) Init() error
  • func (d *Dev) List() error
  • func (d *Dev) Update() error

Types

type Config

type Config struct {
	// LogLevel is the level of the logs to put out
	LogLevel string `hcl:"log_level,optional"`

	// DataDir is the directory to store our state in
	DataDir string

	// ProjectID
	ProjectID string

	// ProjectDir
	ProjectDir string

	// VagrantDir = DataDir + ProjectID
	VagrantDir string

	// Version information (set at compilation time)
	Version *version.VersionInfo
}

Config contains configurations for the Seashell CLI

func DefaultConfig

func DefaultConfig() *Config

DefaultConfig returns a Config struct populated with sane defaults

func (*Config) LoadFromFile

func (c *Config) LoadFromFile(path string) (*Config, error)

LoadFromFile loads the configuration from a given path

func (*Config) Merge

func (c *Config) Merge(b *Config) *Config

Merge merges two Config structs, returning the result

func (*Config) Validate

func (c *Config) Validate() error

Validate returns an error in case a Config struct is invalid.

type Dev

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

Dev :

func New

func New(config *Config, logger log.Logger) (*Dev, error)

New creates a new Dev struct from the configuration, potentially returning an error

func (*Dev) Destroy

func (d *Dev) Destroy() error

Destroy :

func (*Dev) Init

func (d *Dev) Init() error

Init :

func (*Dev) List

func (d *Dev) List() error

List :

func (*Dev) Update

func (d *Dev) Update() error

Update :