cmd

Documentation

Overview

Package cmd provides a quick way to create derived interpreters.

Index

• func Cmd(ctx *goal.Context, cfg Config) error
• type Config

Functions

func Cmd

func Cmd(ctx *goal.Context, cfg Config) error

Cmd runs a goal interpreter with starting context ctx and the given help strings when using the repl. Command line usage is then as follows:

program-name [-d] [-i] [-q] [-version] [-e command | script] [args ...]

The ARGS global variable contains the arguments, starting from script name if given.

Types

type Config

type Config struct {
	Help        func(string) string
	ProgramName string
	Man         string
}

Config describes the possible configuration options when running a *goal.Context through Cmd.