flags

package

v1.0.0 Latest Latest Go to latest Published: Sep 7, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Details

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

Repository

github.com/fugginold/dockwatch

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func EnvConfig(cmd *cobra.Command) error
func GetSecretsFromFiles(rootCmd *cobra.Command)
func ProcessFlagAliases(flags *pflag.FlagSet)
func RegisterDockerFlags(rootCmd *cobra.Command)
func RegisterSystemFlags(rootCmd *cobra.Command)
func SetupLogging(f *pflag.FlagSet) error
type RunFlags
- func ReadFlags(cmd *cobra.Command) RunFlags

Constants ¶

View Source

const DockerAPIMinVersion string = "1.25"

DockerAPIMinVersion is the minimum version of the docker api required to use dockwatch

Variables ¶

This section is empty.

Functions ¶

func EnvConfig ¶

func EnvConfig(cmd *cobra.Command) error

EnvConfig translates the command-line options into environment variables that will initialize the api client

func GetSecretsFromFiles ¶

func GetSecretsFromFiles(rootCmd *cobra.Command)

GetSecretsFromFiles checks if passwords/tokens/webhooks have been passed as a file instead of plaintext. If so, the value of the flag will be replaced with the contents of the file.

func ProcessFlagAliases ¶

func ProcessFlagAliases(flags *pflag.FlagSet)

ProcessFlagAliases updates the value of flags that are being set by helper flags

func RegisterDockerFlags ¶

func RegisterDockerFlags(rootCmd *cobra.Command)

RegisterDockerFlags that are used directly by the docker api client

func RegisterSystemFlags ¶

func RegisterSystemFlags(rootCmd *cobra.Command)

RegisterSystemFlags that are used by dockwatch to modify the program flow

func SetupLogging ¶

func SetupLogging(f *pflag.FlagSet) error

SetupLogging reads only the flags that is needed to set up logging and applies them to the global logger

Types ¶

type RunFlags ¶ added in v0.1.7

type RunFlags struct {
	Cleanup     bool
	NoRestart   bool
	MonitorOnly bool
	Timeout     time.Duration
}

RunFlags holds the common runtime flags read by ReadFlags

func ReadFlags ¶

func ReadFlags(cmd *cobra.Command) RunFlags

ReadFlags reads common flags used in the main program flow of dockwatch

Source Files ¶

View all Source files

flags.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL