commands

Documentation

Overview

Package commands defines and implements command-line commands and flags used by Hugo. Commands and flags are implemented using Cobra.

Package commands defines and implements command-line commands and flags used by Hugo. Commands and flags are implemented using Cobra.

Index

• type Response
  • func Execute(args []string) Response
  • func (r Response) IsUserError() bool

Types

type Response

type Response struct {
	// The build Result will only be set in the hugo build command.
	Result *hugolib.HugoSites

	// Err is set when the command failed to execute.
	Err error

	// The command that was executed.
	Cmd *cobra.Command
}

The Response value from Execute.

func Execute

func Execute(args []string) Response

Execute adds all child commands to the root command HugoCmd and sets flags appropriately. The args are usually filled with os.Args[1:].

func (Response) IsUserError

func (r Response) IsUserError() bool

IsUserError returns true is the Response error is a user error rather than a system error.