github.com/reeflective/flags
Package flags generates CLI application commands/flags by parsing structures. Package flags is the root package of the `github.com/reeflective/flags` library. If you are searching for the list of valid tags to use on structs for specifying commands/flags specs, check https://github.com/reeflective/flags/gen/flags/flags.go. 1) Importing the various packages ----------------------------------------------------- This file gives a list of the various global parsing options that can be passed to the `Generate()` entrypoint function in the `gen/flags` package. Below is an example of how you want to import this package and use its options: package main import ( ) 2) Global parsing options (base) ------------------------------------------------------ Most of the options below are inherited from github.com/octago/sflags, with some added. DescTag sets custom description tag. It is "desc" by default. func DescTag(val string) FlagTag sets custom flag tag. It is "flag" be default. func FlagTag(val string) Prefix sets prefix that will be applied for all flags (if they are not marked as ~). func Prefix(val string) EnvPrefix sets prefix that will be applied for all environment variables (if they are not marked as ~). func EnvPrefix(val string) FlagDivider sets custom divider for flags. It is dash by default. e.g. "flag-name". func FlagDivider(val string) EnvDivider sets custom divider for environment variables. It is underscore by default. e.g. "ENV_NAME". func EnvDivider(val string) Flatten set flatten option. Set to false if you don't want anonymous structure fields to be flatten. func Flatten(val bool) ParseAll orders the parser to generate a flag for all struct fields, even if there isn't a struct tag attached to them. This is because by default the library does not considers untagged field anymore. func ParseAll() 3) Special parsing options/functions--------------------------------------------------- ValidateFunc describes a validation func, that takes string val for flag from command line, field that's associated with this flag in structure `data`. Also works for positional arguments. Should return error if validation fails. type ValidateFunc func(val string, field reflect.StructField, data interface{}) error Validator sets validator function for flags. Check existing validators in flags/validator and flags/validator/govalidator packages. func Validator(val ValidateFunc) FlagFunc is a generic function that can be applied to each value that will end up being a flags *Flag, so that users can perform more arbitrary operations on each, such as checking for completer implementations, bind to viper configurations, etc. type FlagFunc func(flag string, tag tag.MultiTag, val reflect.Value) error FlagHandler sets the handler function for flags, in order to perform arbitrary operations on the value of the flag identified by the <flag> name parameter of FlagFunc. func FlagHandler(val FlagFunc)
Readme
Generate cobra commands from structs
jessevdk/go-flags and octago/sflags compliant tags.
Enhanced with advanced related CLI functionality, at minimum cost.
The flags library allows to declare cobra CLI commands, flags and positional arguments from structs and field tags. It originally aimed to enhance go-flags, but ended up shifting its approach in order to leverage the widely used and battle-tested cobra CLI library. In addition, it provides other generators leveraging the carapace completion engine, thus allowing for very powerful yet simple completion and as-you-type usage generation for the commands, flags and positional arguments.
In short, the main purpose of this library is to let users focus on writing programs. It requires very little time and focus spent on declaring CLI interface specs (commands, flags, groups of flags/commands) and associated functionality (completions and validations), and then generates powerful and ready to use CLI programs.
cobra.Args.This library is currently in a pre-release candidate state, for several reasons:
Please open a PR or an issue if you wish to bring enhancements to it. For newer features, please consider if there is a large number of people who might benefit from it, or if it has a chance of impairing on future development. If everything is fine, please propose ! Other contributions, as well as bug fixes and reviews are also welcome.
FAQs
Package flags generates CLI application commands/flags by parsing structures. Package flags is the root package of the `github.com/reeflective/flags` library. If you are searching for the list of valid tags to use on structs for specifying commands/flags specs, check https://github.com/reeflective/flags/gen/flags/flags.go. 1) Importing the various packages ----------------------------------------------------- This file gives a list of the various global parsing options that can be passed to the `Generate()` entrypoint function in the `gen/flags` package. Below is an example of how you want to import this package and use its options: package main import ( ) 2) Global parsing options (base) ------------------------------------------------------ Most of the options below are inherited from github.com/octago/sflags, with some added. DescTag sets custom description tag. It is "desc" by default. func DescTag(val string) FlagTag sets custom flag tag. It is "flag" be default. func FlagTag(val string) Prefix sets prefix that will be applied for all flags (if they are not marked as ~). func Prefix(val string) EnvPrefix sets prefix that will be applied for all environment variables (if they are not marked as ~). func EnvPrefix(val string) FlagDivider sets custom divider for flags. It is dash by default. e.g. "flag-name". func FlagDivider(val string) EnvDivider sets custom divider for environment variables. It is underscore by default. e.g. "ENV_NAME". func EnvDivider(val string) Flatten set flatten option. Set to false if you don't want anonymous structure fields to be flatten. func Flatten(val bool) ParseAll orders the parser to generate a flag for all struct fields, even if there isn't a struct tag attached to them. This is because by default the library does not considers untagged field anymore. func ParseAll() 3) Special parsing options/functions--------------------------------------------------- ValidateFunc describes a validation func, that takes string val for flag from command line, field that's associated with this flag in structure `data`. Also works for positional arguments. Should return error if validation fails. type ValidateFunc func(val string, field reflect.StructField, data interface{}) error Validator sets validator function for flags. Check existing validators in flags/validator and flags/validator/govalidator packages. func Validator(val ValidateFunc) FlagFunc is a generic function that can be applied to each value that will end up being a flags *Flag, so that users can perform more arbitrary operations on each, such as checking for completer implementations, bind to viper configurations, etc. type FlagFunc func(flag string, tag tag.MultiTag, val reflect.Value) error FlagHandler sets the handler function for flags, in order to perform arbitrary operations on the value of the flag identified by the <flag> name parameter of FlagFunc. func FlagHandler(val FlagFunc)
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A hospital in Mobile, Alabama, agreed to a settlement in a landmark ransomware death lawsuit, but is now reportedly reconsidering the agreement and refusing to pay.
Security News
A new report explores how advancements in LLMs are enhancing cyber threats, including polymorphic malware, personalized spearphishing, and the risk of hijacking customer service bots.
Security News
ESLint has approved an RFC that adds support for TypeScript configuration files, which is aimed at improving the developer experience and recognizing changes in the evolving JavaScript ecosystem.