types

Documentation

Overview

Golang structs for scw commands

Index

• type Command
  • func (c *Command) ExamplesHelp() string
  • func (c *Command) Name() string
  • func (c *Command) Options() string
  • func (c *Command) PrintShortUsage()
  • func (c *Command) PrintUsage()

Types

type Command

type Command struct {
	// Exec executes the command
	Exec func(cmd *Command, args []string)

	// Usage is the one-line usage message.
	UsageLine string

	// Description is the description of the command
	Description string

	// Help is the full description of the command
	Help string

	// Examples are some examples of the command
	Examples string

	// Flag is a set of flags specific to this command.
	Flag flag.FlagSet

	// Hidden is a flat to hide command from global help commands listing
	Hidden bool

	// API is the interface used to communicate with Scaleway's API
	API *api.ScalewayAPI
}

Command is a Scaleway command

func (*Command) ExamplesHelp

func (c *Command) ExamplesHelp() string

ExamplesHelp returns a string describing examples of the command

func (*Command) Name

func (c *Command) Name() string

Name returns the command's name

func (*Command) Options

func (c *Command) Options() string

Options returns a string describing options of the command

func (*Command) PrintShortUsage

func (c *Command) PrintShortUsage()

PrintShortUsage prints a short command usage and exits

func (*Command) PrintUsage

func (c *Command) PrintUsage()

PrintUsage prints a full command usage and exits