cmd

Documentation

Index

• Variables
• func App(appVersion string) *cli.App
• func RegisterCommand(name string, factory CommandFactory) error
• type CommandFactory
• type Config
  • func DefaultConfig() Config
  • func LoadConfig(path string) (config *Config, err error)
• type File

Variables

var ErrDatasourceNotLoaded = errors.New("could not load configuration: no database source specified")

ErrDatasourceNotLoaded is returned when the datasource variable in the configuration file is not loaded properly

Functions

func App

func App(appVersion string) *cli.App

App func init

func RegisterCommand

func RegisterCommand(name string, factory CommandFactory) error

RegisterCommand adds a new command factory that will be used to build cli commands and returns error if factory is nil or command has always been registered

Types

type CommandFactory

type CommandFactory func() cli.Command

CommandFactory func init

type Config

type Config struct {
	Database datastore.BackendConfig
	API      *api.Config
}

Config is the global configuration for an instance of Port Authority

func DefaultConfig

func DefaultConfig() Config

DefaultConfig is a configuration that can be used as a fallback value

func LoadConfig

func LoadConfig(path string) (config *Config, err error)

LoadConfig is a shortcut to open a file, read it, and generate a Config. It supports relative and absolute paths. Given "", it returns DefaultConfig.

type File

type File struct {
	PortAuthority Config `yaml:"portauthority"`
}

File represents a YAML configuration file that namespaces all Port Authority configuration under the top-level "portauthority" key