command

Documentation

Overview

Package command serves as the main entry point to the tiyo application and its relevant primary sub-commands `assemble`, `flow`, `fill` and `syphon`

Index

• Constants
• func Run(args []string) int
• func SetupLog()
• func Usage()
• type Command

Constants

const VERSION string = "v0.0.1a"

VERSION : The applications current version number

Functions

func Run

func Run(args []string) int

Run : Main entry for the primary wrapper

func SetupLog

func SetupLog()

SetupLog : configure the primary application logging system

By default, the logging level is info but this can be controlled by the environment variable TIYO_LOG if a finer level of control is required.

func Usage

func Usage()

Usage : print usage information about the main application

Types

type Command

type Command interface {
	Init()
	Run() int
}

Command : define the main interface for sub-commands

Any primary subcommand executable by this wrapper needs to implement this interface.