cli

Documentation

Index

• Constants
• Variables
• func SetContext(c context.Context)
• func SetLogger(l Logger)
• func SetVersion(v string)
• func ValidStyles() []string
• type ActTLSCmd
• type Logger
• type Options
  • func ConfigureInApp(app *fisk.Application, cliOpts *Options, prepare bool, disable ...string) (*Options, error)
  • func ConfigureInCommand(cmd *fisk.CmdClause, cliOpts *Options, prepare bool, disable ...string) (*Options, error)
• type SchemaValidator
  • func (v SchemaValidator) ValidateStruct(data any, schemaType string) (ok bool, errs []string)
• type SrvCheckCmd
• type SrvClusterCmd
• type SrvConfigCmd
• type SrvInfoCmd
• type SrvLsCmd
• type SrvMappingCmd
• type SrvPasswdCmd
• type SrvPingCmd
• type SrvReportCmd
• type SrvRequestCmd
• type SrvRunCmd
• type SrvRunConfig
• type SrvWatchAccountCmd
• type SrvWatchJSCmd
• type SrvWatchServerCmd

Constants

const (
	Skipped auditCheckOutcome = iota
	Pass
	Fail
	SomeIssues
)

const (
	DefaultDurableConsumerName string = "natscli-bench"
	DefaultStreamName          string = "benchstream"
	DefaultBucketName          string = "benchbucket"
)

Variables

var SkipContexts bool

SkipContexts used during tests

var (
	Version = "development"
)

Functions

func SetContext

func SetContext(c context.Context)

SetContext sets the context to use

func SetLogger

func SetLogger(l Logger)

SetLogger sets a custom logger to use

func SetVersion

func SetVersion(v string)

func ValidStyles

func ValidStyles() []string

ValidStyles are valid color styles this package supports

Types

type ActTLSCmd

type ActTLSCmd struct {
	// contains filtered or unexported fields
}

type Logger

type Logger interface {
	Printf(format string, a ...any)
	Fatalf(format string, a ...any)
	Print(a ...any)
	Fatal(a ...any)
	Println(a ...any)
}

Logger provides a pluggable logger implementation

type Options

type Options struct {
	// Config is a nats configuration context
	Config *natscontext.Context
	// Servers is the list of servers to connect to
	Servers string
	// Creds is nats credentials to authenticate with
	Creds string
	// TlsCert is the TLS Public Certificate
	TlsCert string
	// TlsKey is the TLS Private Key
	TlsKey string
	// TlsCA is the certificate authority to verify the connection with
	TlsCA string
	// Timeout is how long to wait for operations
	Timeout time.Duration
	// ConnectionName is the name to use for the underlying NATS connection
	ConnectionName string
	// Username is the username or token to connect with
	Username string
	// Password is the password to connect with
	Password string
	// Nkey is the file holding a nkey to connect with
	Nkey string
	// JsApiPrefix is the JetStream API prefix
	JsApiPrefix string
	// JsEventPrefix is the JetStream events prefix
	JsEventPrefix string
	// JsDomain is the domain to connect to
	JsDomain string
	// CfgCtx is the context name to use
	CfgCtx string
	// Trace enables verbose debug logging
	Trace bool
	// Customer inbox Prefix
	InboxPrefix string
	// Conn sets a prepared connect to connect with
	Conn *nats.Conn
	// Mgr sets a prepared jsm Manager to use for JetStream access
	Mgr *jsm.Manager
	// JSc is a prepared NATS JetStream context to use for KV and Object access
	JSc nats.JetStreamContext
	// Disables registering of CLI cheats
	NoCheats bool
	// PrometheusNamespace is the namespace to use for prometheus format output in server check
	PrometheusNamespace string
	// SocksProxy is a SOCKS5 proxy to use for NATS connections
	SocksProxy string
	// ColorScheme influence table colors and more based on ValidStyles()
	ColorScheme string
	// TlsFirst configures the TLSHandshakeFirst behavior in nats.go
	TlsFirst bool
	// WinCertStoreType enables windows cert store - user or machine
	WinCertStoreType string
	// WinCertStoreMatchBy configures how to search for certs when using match - subject or issuer
	WinCertStoreMatchBy string
	// WinCertStoreMatch is the query to match with
	WinCertStoreMatch string
	// WinCertCaStoreMatch is the queries for CAs to use
	WinCertCaStoreMatch []string
}

Options configure the CLI

func ConfigureInApp

func ConfigureInApp(app *fisk.Application, cliOpts *Options, prepare bool, disable ...string) (*Options, error)

ConfigureInApp attaches the cli commands to app, prepare will load the context on demand and should be true unless override nats, manager and js context is given in a custom PreAction in the caller. Disable is a list of command names to skip.

func ConfigureInCommand

func ConfigureInCommand(cmd *fisk.CmdClause, cliOpts *Options, prepare bool, disable ...string) (*Options, error)

ConfigureInCommand attaches the cli commands to cmd, prepare will load the context on demand and should be true unless override nats, manager and js context is given in a custom PreAction in the caller. Disable is a list of command names to skip.

type SchemaValidator

type SchemaValidator struct{}

func (SchemaValidator) ValidateStruct

func (v SchemaValidator) ValidateStruct(data any, schemaType string) (ok bool, errs []string)

type SrvCheckCmd

type SrvCheckCmd struct {
	// contains filtered or unexported fields
}

type SrvClusterCmd

type SrvClusterCmd struct {
	// contains filtered or unexported fields
}

type SrvConfigCmd

type SrvConfigCmd struct {
	// contains filtered or unexported fields
}

type SrvInfoCmd

type SrvInfoCmd struct {
	// contains filtered or unexported fields
}

type SrvLsCmd

type SrvLsCmd struct {
	// contains filtered or unexported fields
}

type SrvMappingCmd

type SrvMappingCmd struct {
	// contains filtered or unexported fields
}

type SrvPasswdCmd

type SrvPasswdCmd struct {
	// contains filtered or unexported fields
}

type SrvPingCmd

type SrvPingCmd struct {
	// contains filtered or unexported fields
}

type SrvReportCmd

type SrvReportCmd struct {
	// contains filtered or unexported fields
}

type SrvRequestCmd

type SrvRequestCmd struct {
	// contains filtered or unexported fields
}

type SrvRunCmd

type SrvRunCmd struct {
	// contains filtered or unexported fields
}

type SrvRunConfig

type SrvRunConfig struct {
	Name                 string
	Port                 string
	UserPassword         string
	UserPasswordCrypt    string
	ServicePassword      string
	ServicePasswordCrypt string
	SystemPassword       string
	SystemPasswordCrypt  string
	ExtendDemoNetwork    bool
	ExtendWithContext    bool
	JetStream            bool
	JSDomain             string
	Verbose              bool
	Debug                bool
	StoreDir             string
	Clean                bool
	MonitorPort          int
	Context              *natscontext.Context
}

type SrvWatchAccountCmd

type SrvWatchAccountCmd struct {
	// contains filtered or unexported fields
}

type SrvWatchJSCmd

type SrvWatchJSCmd struct {
	// contains filtered or unexported fields
}

type SrvWatchServerCmd

type SrvWatchServerCmd struct {
	// contains filtered or unexported fields
}