config

Documentation

Index

• Variables
• type AuthFlags
• type Config
  • func New() *Config
  • func (c *Config) Cwd() (string, error)
  • func (c *Config) HomeDir() (string, error)
  • func (c *Config) InitDefaultConfig() error
  • func (c *Config) LoadSpec() error
  • func (c *Config) Vars() []string
• type Flags
  • func NewFlags() Flags
• type TaskFlags

Variables

var DefaultConfig = New()

DefaultConfig is the default configuration.

Types

type AuthFlags

type AuthFlags struct {
	Dex             bool   `envconfig:"DEX" default:"true"`
	DexClientID     string `envconfig:"DEX_CLIENT_ID"`
	DexClientSecret string `envconfig:"DEX_CLIENT_SECRET"`
	DexClientURL    string `envconfig:"DEX_CLIENT_URL"`
}

AuthFlags contains the flags for the authentication.

type Config

type Config struct {
	URL    string
	Flags  *Flags
	Store  string
	Stdin  *os.File
	Stdout *os.File
	Stderr *os.File
	Spec   *specs.Spec
	File   string
	Path   string
	Plugin string
	sync.RWMutex
	FileMode os.FileMode
	Verbose  bool
	Task     TaskFlags
}

Config contains the configuration.

func New

func New() *Config

New returns a new config.

func (*Config) Cwd

func (c *Config) Cwd() (string, error)

Cwd returns the current working directory.

func (*Config) HomeDir

func (c *Config) HomeDir() (string, error)

HomeDir returns the home directory.

func (*Config) InitDefaultConfig

func (c *Config) InitDefaultConfig() error

InitDefaultConfig initializes the default configuration.

func (*Config) LoadSpec

func (c *Config) LoadSpec() error

LoadSpec is a helper to load the spec from the config file.

func (*Config) Vars

func (c *Config) Vars() []string

Vars returns the variables.

type Flags

type Flags struct {
	// Plugins contains the plugins to use.
	Plugins []string
	// Vars contains the variables to use.
	Vars []string
	// Dry indicates whether to print dry run messages.
	Dry bool
	// Force indicates whether to force overwrite.
	Force bool
	// Root is the root directory of the project.
	Root bool
	// Verbose indicates whether to print verbose messages.
	Verbose bool
	// Version indicates whether to print version.
	Version bool
	// TaskFlags contains the flags for a task.
	TaskFlags TaskFlags
	// AuthFlags contains the flags for the authentication.
	AuthFlags AuthFlags
}

Flags contains the command line flags.

func NewFlags

func NewFlags() Flags

NewFlags returns a new flags.

type TaskFlags

type TaskFlags struct {
	// Name is the name of the task to execute.
	Name string
}

TaskFlags contains the flags for a task.