cli

Documentation

Index

• Constants
• type CLI
  • func (c *CLI) Read() ([]byte, error)
  • func (c *CLI) Routes() error
  • func (c *CLI) Run() error
  • func (c *CLI) Usage() string
• type Yaml
• type YamlFunc
  • func (f YamlFunc) Read() ([]byte, error)

Constants

const (
	// ExitCodeOK is no error status
	ExitCodeOK = 0

	// ExitCodeError is error status
	ExitCodeError = 1
)

const CalciumFile = "calcium.yml"

CalciumFile is file name

Types

type CLI

type CLI struct {
	In, Out, Err io.Writer
	Args         []string
	Yaml
}

CLI for commad

func (*CLI) Read

func (c *CLI) Read() ([]byte, error)

Read return Yaml

func (*CLI) Routes

func (c *CLI) Routes() error

Routes is command routing

func (*CLI) Run

func (c *CLI) Run() error

Run execute shell script

func (*CLI) Usage

func (c *CLI) Usage() string

Usage give cli usage

type Yaml

type Yaml interface {
	Read() ([]byte, error)
}

Yaml behave yaml

type YamlFunc

type YamlFunc func() ([]byte, error)

YamlFunc implements Yaml interface

func (YamlFunc) Read

func (f YamlFunc) Read() ([]byte, error)

Read return yaml