cli

Documentation

Overview

Package cli provides helpers to work with command-line interface.

Index

• Variables
• func Filename(args []string) (string, error)
• func GetFloat() (float64, error)
• func ProgName(args []string) string

Variables

var (
	ErrEmptyFilename         = errors.New("cli: empty filename")
	ErrInsufficientArguments = errors.New("cli: insufficient command-line arguments")
	ErrInvalidFilename       = errors.New("cli: invalid filename")
	ErrParseFloat            = errors.New("cli: failed to parse float")
	ErrReadString            = errors.New("cli: failed to read string")
	ErrTooManyArguments      = errors.New("cli: too many arguments")
)

Functions

func Filename

func Filename(args []string) (string, error)

Filename returns the value of args[1] as the required filename, os.Args is required to pass in args.

func GetFloat

func GetFloat() (float64, error)

GetFloat reads a floating-point number from os.Stdin. It returns the number read and any error encountered.

func ProgName

func ProgName(args []string) string

ProgName returns the program name from the command-line arguments.