cmd

package

v0.2.4 Latest Latest Go to latest Published: Jan 25, 2024 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/senzing-garage/template-go

Links

Open Source Insights

Documentation ¶

Rendered for

Overview ¶

The cmd package is used for Cobra integration.

0.2.4 Created by make-go-github-file.yaml on Mon Oct 23 13:34:41 UTC 2023

Index ¶

Constants
Variables
func Execute()
func PreRun(cobraCommand *cobra.Command, args []string)
func RunE(_ *cobra.Command, _ []string) error
func Version() string

Constants ¶

View Source

const (
	Short string = "template-go short description"
	Use   string = "template-go"
	Long  string = `
template-go long description.
    `
)

Variables ¶

View Source

var ContextVariables = append(ContextVariablesForMultiPlatform, ContextVariablesForOsArch...)

View Source

var ContextVariablesForMultiPlatform = []option.ContextVariable{
	option.Configuration,
	option.EngineConfigurationJson,
	option.LogLevel,
	SomethingToSay,
}

View Source

var ContextVariablesForOsArch = []option.ContextVariable{}

View Source

var RootCmd = &cobra.Command{
	Use:     Use,
	Short:   Short,
	Long:    Long,
	PreRun:  PreRun,
	RunE:    RunE,
	Version: Version(),
}

RootCmd represents the command.

View Source

var SomethingToSay = option.ContextVariable{
	Arg:     "something-to-say",
	Default: option.OsLookupEnvString("SENZING_TOOLS_SOMETHING_TO_SAY", "Main says 'Hi!'"),
	Envar:   "SENZING_TOOLS_SOMETHING_TO_SAY",
	Help:    "Just a phrase to say [%s]",
	Type:    optiontype.String,
}

Functions ¶

func Execute ¶

func Execute()

Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the RootCmd.

func PreRun ¶

func PreRun(cobraCommand *cobra.Command, args []string)

Used in construction of cobra.Command

func RunE ¶

func RunE(_ *cobra.Command, _ []string) error

Used in construction of cobra.Command

func Version ¶

func Version() string

Used in construction of cobra.Command

Types ¶

This section is empty.

Source Files ¶

View all Source files

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