sample

Documentation

Overview

Package sample provides sample commands that demonstrate the command package.

Boiler plate flag-based command for convenience:

type SampleCommand struct {
	command.FlagCommandBase
}

func NewSampleCommand() *SampleCommand {
	return &SampleCommand{
		FlagCommandBase: command.NewFlagCommandBase("name", "description"),
	}
}

func (cmd SampleCommand) Run(args []string) error {
	return nil
}

Index

• type HelloCommand
  • func NewHelloCommand() *HelloCommand
  • func (cmd HelloCommand) Run(args []string) error

Types

type HelloCommand

type HelloCommand struct {
	command.FlagCommandBase
}

Sample hello command for printing "Hello" to the console.

func NewHelloCommand

func NewHelloCommand() *HelloCommand

Create a new HelloCommand.

func (HelloCommand) Run

func (cmd HelloCommand) Run(args []string) error

Run the command. See usage string for details.