local

Documentation

Index

• Constants
• func Dir() string
• func IsMissingDir(e error) bool
• func NewModules(plugins func() discovery.Plugins, dir string) (cli.Modules, error)
• func Setup() error

Constants

const (
	// DefaultCLIExtension is the file extension used to mark a file as an infrakit cli command.
	// Typically templates have the .ikt extension, while CLI commands have .ikc extension
	DefaultCLIExtension = ".ikc"
)

Functions

func Dir

func Dir() string

Dir returns the directory to use for modules, which may be customized by the environment.

func IsMissingDir

func IsMissingDir(e error) bool

IsMissingDir returns if the error is from missing or not a directory

func NewModules

func NewModules(plugins func() discovery.Plugins, dir string) (cli.Modules, error)

NewModules returns an implementation of Modules using data found locally on disk

func Setup

func Setup() error

Setup sets up the necessary environment for running this module -- ie make sure the CLI module directories are present, etc.