task

Documentation

Overview

Package task provides the “--task” CLI flag to enable task discovery.

Use Enabled to query whether task discovery has been requested (enabled), or FromTasks that instead returns an appropriate discovery option.

Index

• Constants
• func Enabled(cmd *cobra.Command) bool
• func FromTasks(cmd *cobra.Command) discover.DiscoveryOption
• func SetupCLI(cmd *cobra.Command)

Constants

const (
	TaskFlagName = "task"
)

Names of the CLI flags defined and used in this package.

Functions

func Enabled

func Enabled(cmd *cobra.Command) bool

Enabled returns true if tasks should be discovered, otherwise false.

func FromTasks

func FromTasks(cmd *cobra.Command) discover.DiscoveryOption

FromTasks returns a discover.FromTasks option if task discovery has been requested on the CLI, otherwise nil.

func SetupCLI

func SetupCLI(cmd *cobra.Command)

SetupCLI adds the "task" flag to enable/disable task discovery.