clippy

README

clippy

...an opinionated modular cobra CLI support Go module, with the emphasis being on "modular". Instead of lumping all flag configuration and processing into one big mess, why not neatly cutting it into logical chunks (or "plugins").

DevContainer

[!CAUTION]

Do not use VSCode's "Dev Containers: Clone Repository in Container Volume" command, as it is utterly broken by design, ignoring .devcontainer/devcontainer.json.

1. git clone https://github.com/thediveo/clippy
2. in VSCode: Ctrl+Shift+P, "Dev Containers: Open Workspace in Container..."
3. select clippy.code-workspace and off you go...

Supported Go Versions

clippy supports versions of Go that are noted by the Go release policy, that is, major versions N and N-1 (where N is the current major version).

Contributing

Please see CONTRIBUTING.md.

Copyright and License

clippy is Copyright 2024, 2025 Harald Albrecht, and licensed under the Apache License, Version 2.0.

Documentation

Overview

Package clippy handles registering CLI flags via a plug-in mechanism. Additionally, optional CLI flag handling can be carried out after the CLI flags have been parsed and just right before the selected command is about to run.

Packages providing CLI flags need to register themselves using the go-plugger mechanism providing functions assignable to cliplugin.SetupCLI. This makes it possible to register multiple flags from the same package in a highly modular fashion just by specifying individual plug-in functions, for instance, per each individual flag.

Registering cliplugin.BeforeCommand functions allows for modular processing of flags before the (root) command is run.

Registration of the exported functions should be done in init functions. For better modularity, multiple registration-related init functions can perfectly co-exist within the same package. You might want to specify different “plug-in names” upon function registration.

It already sufficies when a cmd package references a CLI-related package to pull in its CLI flag registrations. A cmd package then should make sure to call AddFlags and BeforeCommand respectively.

AddFlags should be called after your cmd package has created the root command object and is ready for registering flags.

BeforeCommand should be called from the PersistentPreRunE hook function of your cmd package's root command object.

Index

• func AddFlags(rootCmd *cobra.Command)
• func BeforeCommand(cmd *cobra.Command) error

Functions

func AddFlags

func AddFlags(rootCmd *cobra.Command)

AddFlags runs all registered cliplugin.SetupCLI plugin functions in order to register CLI flags for the specified root command.

func BeforeCommand

func BeforeCommand(cmd *cobra.Command) error

BeforeCommand runs all registered cliplugin.BeforeCommand plugin functions just before the selected command runs; it terminates as soon as the first plugin function returns a non-nil error.