Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Main ¶ added in v1.6.14
Main is the main entry point for all commands. It parses command-line arguments and then dispatches to the appropriate command handler.
func TerminalWidth ¶ added in v1.6.21
func TerminalWidth() int
TerminalWidth returns the width of os.Stdout if it is a terminal, or zero otherwise.
Types ¶
type OpenAPICommand ¶ added in v1.6.19
type OpenAPICommands ¶ added in v1.6.19
type OpenAPICommands struct {
OpenAPI OpenAPICommand `cmd:"" name:"openapi" help:"Show OpenAPI documentation in a browser, or output the spec as JSON or YAML." group:"SERVER"`
}
type RegisterFunc ¶ added in v1.6.14
type RegisterFunc func(*httprouter.Router) error
RegisterFunc is called after the server URL has been resolved but before the server starts serving requests. Use it to add routes and wire up handlers.
type RunServer ¶ added in v1.6.14
type RunServer struct {
OpenAPI bool `name:"openapi" help:"Serve OpenAPI spec at {prefix}/openapi.{json,yaml,html}" default:"true" negatable:""`
// TLS server options
TLS struct {
ServerName string `name:"name" help:"TLS server name"`
CertFile string `name:"cert" help:"TLS certificate file"`
KeyFile string `name:"key" help:"TLS key file"`
} `embed:"" prefix:"tls."`
// HTTP server options
HTTP struct {
Origin string `` /* 202-byte string literal not displayed */
} `embed:"" prefix:"http."`
// contains filtered or unexported fields
}
RunServer is a general-purpose "run" command. Embed it in your CLI's command struct to get a fully functional HTTP server with logging and OTel middleware.
func (*RunServer) Register ¶ added in v1.6.14
func (s *RunServer) Register(fns ...RegisterFunc) *RunServer
Register appends fns to the list of functions called to wire up routes before the server starts. Returns the receiver for chaining.