cmd

Documentation

Overview

The cmd package is used for Cobra integration.

0.7.1 Created by make-go-github-file.yaml on Fri Mar 1 17:59:38 UTC 2024

Index

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

Constants

const (
	Short string = "Start a gRPC server for the Senzing SDK API"
	Use   string = "serve-grpc"
	Long  string = `
Start a gRPC server for the Senzing SDK API.
For more information, visit https://github.com/senzing-garage/serve-grpc
    `
)

Variables

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

var ContextVariablesForMultiPlatform = []option.ContextVariable{
	option.Configuration,
	option.DatabaseUrl,
	option.EnableAll,
	option.EnableSzConfig,
	option.EnableSzConfigManager,
	option.EnableSzDiagnostic,
	option.EnableSzEngine,
	option.EnableSzProduct,
	option.EngineConfigurationJson,
	option.EngineLogLevel,
	option.EngineModuleName,
	option.GrpcPort,
	option.GrpcUrl,
	option.HttpPort,
	option.LogLevel,
	option.ObserverOrigin,
	option.ObserverUrl,
}

var ContextVariablesForOsArch = []option.ContextVariable{}

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

RootCmd represents the command.

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