commands

package
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 20, 2022 License: Apache-2.0 Imports: 76 Imported by: 0

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

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Response added in v0.40.1

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 added in v0.40.1

func (r Response) IsUserError() bool

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

Jump to

Keyboard shortcuts

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