cmd

package

v0.2.2 Latest Latest Go to latest Published: Jul 3, 2024 License: Apache-2.0 Imports: 19 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/senzing-garage/serve-http

Links

Open Source Insights

Documentation ¶

Rendered for

Overview ¶

The cmd package is used for Cobra integration.

0.2.2 Created by make-go-github-file.yaml on Tue Jan 30 16:25:04 UTC 2024

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 = "HTTP server supporting various services"
	Use   string = "serve-http"
	Long  string = `
An HTTP server supporting the following services:
	- Senzing API server
	- Swagger UI
	- Xterm
	`
)

Variables ¶

View Source

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

View Source

var ContextVariablesForMultiPlatform = []option.ContextVariable{
	avoidServe,
	option.Configuration,
	option.DatabaseURL,
	option.EnableAll,
	option.EnableSenzingRestAPI,
	option.EnableSwaggerUI,
	option.EnableXterm,
	option.EngineConfigurationJSON,
	option.EngineLogLevel,
	option.EngineModuleName,
	option.GrpcURL,
	option.HTTPPort,
	option.LogLevel,
	option.ObserverOrigin,
	option.ObserverURL,
	option.ServerAddress,
	option.TtyOnly,
	option.XtermAllowedHostnames.SetDefault(getDefaultAllowedHostnames()),
	option.XtermArguments,
	option.XtermCommand,
	option.XtermConnectionErrorLimit,
	option.XtermKeepalivePingTimeout,
	option.XtermMaxBufferSizeBytes,
}

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.

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