cli

Documentation

Overview

Package cli provides a CLI UI for the gorram command line tool.

Index

• Constants
• func ParseAndRun(env OSEnv) int
• func Run() int
• type OSEnv
• type UI
  • func Parse(env OSEnv) (*UI, error)

Constants

const CacheEnv = "GORRAM_CACHE"

CacheEnv is the environment variable that users may set to change the location where gorram stores its script files.

Functions

func ParseAndRun

func ParseAndRun(env OSEnv) int

ParseAndRun parses the environment to create a run.Command and runs it. It returns the code that should be used for os.Exit.

func Run

func Run() int

Run parses the gorram command line args and runs the gorram command.

Types

type OSEnv

type OSEnv struct {
	Args   []string
	Stderr io.Writer
	Stdout io.Writer
	Stdin  io.Reader
	Env    map[string]string
}

OSEnv encapsulates the gorram environment.

type UI

type UI struct {
	Regen    bool
	Template string
	Cache    string
	Args     []string
}

UI represents the UI of the CLI, including flags and actions.

func Parse

func Parse(env OSEnv) (*UI, error)

Parse converts the gorram command line. If an error is returned, the program should exit with the code specified by the error's Code() int function.