Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

cmdopts

package

Go to main page

Versions in this module

v3

v3.7.0

Jul 21, 2025

v3.6.0

Jul 16, 2025

v3.5.0

Jun 5, 2025

v3.4.0

May 23, 2025

v3.3.0

May 12, 2025

Changes in this version

type Options

+ OutputWriter io.Writer

type SourceCommand

+ Resolve SourceResolveCommand

+ type SourceResolveCommand struct

+ func (cmd *SourceResolveCommand) Execute(args []string) error

v3.2.0

Mar 25, 2025

Changes in this version

type Options

+ SinksWriter sinks.Writer

+ func (c *Options) InitSinkWriter(ctx context.Context) (err error)

v3.1.0

Feb 13, 2025

Changes in this version

type Options

+ func (c *Options) ValidateConfig() error

v3.0.0

Dec 17, 2024

Changes in this version

+ const ExitCodeCmdError

+ const ExitCodeConfigError

+ const ExitCodeFatalError

+ const ExitCodeOK

+ const ExitCodeShutdownCommand

+ const ExitCodeUpgradeError

+ const ExitCodeUserCancel

+ const ExitCodeWebUIError

+ type ConfigCommand struct

+ Init ConfigInitCommand

+ Upgrade ConfigUpgradeCommand

+ func NewConfigCommand(owner *Options) *ConfigCommand

+ type ConfigInitCommand struct

+ func (cmd *ConfigInitCommand) Execute([]string) error

+ func (cmd *ConfigInitCommand) InitMetrics()

+ func (cmd *ConfigInitCommand) InitSources()

+ type ConfigUpgradeCommand struct

+ func (cmd *ConfigUpgradeCommand) Execute([]string) (err error)

+ type Kind int

+ const ConfigError

+ const ConfigFile

+ const ConfigFolder

+ const ConfigPgURL

+ type MetricCommand struct

+ PrintInit MetricPrintInitCommand

+ PrintSQL MetricPrintSQLCommand

+ func NewMetricCommand(owner *Options) *MetricCommand

+ type MetricPrintInitCommand struct

+ func (cmd *MetricPrintInitCommand) Execute(args []string) error

+ type MetricPrintSQLCommand struct

+ Version int

+ func (cmd *MetricPrintSQLCommand) Execute(args []string) error

+ type Options struct

+ CommandCompleted bool

+ ExitCode int32

+ Help bool

+ Logging log.CmdOpts

+ Metrics metrics.CmdOpts

+ MetricsReaderWriter metrics.ReaderWriter

+ Sinks sinks.CmdOpts

+ Sources sources.CmdOpts

+ SourcesReaderWriter sources.ReaderWriter

+ WebUI webserver.CmdOpts

+ func New(writer io.Writer) (cmdOpts *Options, err error)

+ func (c *Options) CompleteCommand(code int32)

+ func (c *Options) GetConfigKind(arg string) (_ Kind, err error)

+ func (c *Options) InitConfigReaders(ctx context.Context) error

+ func (c *Options) InitMetricReader(ctx context.Context) (err error)

+ func (c *Options) InitSourceReader(ctx context.Context) (err error)

+ func (c *Options) InitWebUI(fs fs.FS, logger log.LoggerIface) error

+ func (c *Options) IsPgConnStr(arg string) bool

+ func (c *Options) NeedsSchemaUpgrade() (upgrade bool, err error)

+ func (c *Options) Verbose() bool

+ type SourceCommand struct

+ Ping SourcePingCommand

+ func NewSourceCommand(owner *Options) *SourceCommand

+ type SourcePingCommand struct

+ func (cmd *SourcePingCommand) Execute(args []string) error

Other modules containing this package

github.com/cybertec-postgresql/pgwatch/v5