scli

package module

v0.0.0-...-230b801 Latest Latest Go to latest Published: Jan 30, 2020 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

bitbucket.org/antizealot1337/scli

Links

Open Source Insights

README ¶

SCLI

A simple command line interface with flags and (sub)commands.

License

Documentation ¶

Index ¶

type App
type Cmd
- func (c *Cmd) Matches(s string) bool
- func (c *Cmd) Run(args []string) error
type Command

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type App ¶

type App struct {
	Name    string
	Version string
	Desc    string
	Flags   flag.FlagSet
	Cmds    []*Cmd
	Exec    func(args []string) error

} //struct

App is the root of a scli command line application. It has fields to display when help is called and optional commands and a default function to execute if no commands are run.

func (*App) Run ¶

func (a *App) Run() (err error)

Run is the same as RunWith(os.Args)

func (*App) RunWith ¶

func (a *App) RunWith(args []string) (err error)

RunWith runs the App with the supplied args. That args are first parsed through the flags with the remaining passed to a command or the Exec func. The args are expected to be in the form of ["executable name", "flags and args"...].

func (*App) WriteUsage ¶

func (a *App) WriteUsage(out io.Writer) error

WriteUsage will write the usage to the supplied io.Writer.

type Cmd ¶

type Cmd struct {
	Name string
	Desc string
	Exec func(args []string) error
	Subs []*Cmd

} //struct

Cmd is a command that can be run from an App.

func (*Cmd) Matches ¶

func (c *Cmd) Matches(s string) bool

Matches checks if the command should run based on the supplied string.

func (*Cmd) Run ¶

func (c *Cmd) Run(args []string) error

Run executes the command with the supplied args.

type Command ¶

type Command interface {
	Matches(s string) bool
	Run(args []string) error

} //interface

Command is a representation "subcommands" present on the command line.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL