README
¶
PCLI ✨
PCLI is a custom Go module for pterm/cli-template, which handles all of its logic.
Documentation
¶
Index ¶
- Variables
- func FlagErrorFunc(rootCmd *cobra.Command) func(*cobra.Command, error) error
- func GenerateMarkdownDocs(command, rootCmd *cobra.Command) (markdown []string)
- func GlobalNormalizationFunc(rootCmd *cobra.Command) func(f *pflag.FlagSet, name string) pflag.NormalizedName
- func HelpFunc(rootCmd *cobra.Command) func(*cobra.Command, []string)
- func HelpTemplate(rootCmd *cobra.Command) string
- func UsageFunc(rootCmd *cobra.Command) func(*cobra.Command) error
- func UsageTemplate(rootCmd *cobra.Command) string
- func VersionTemplate(rootCmd *cobra.Command) string
Constants ¶
This section is empty.
Variables ¶
var HelpSectionPrinter = pterm.DefaultSection.WithLevel(2).Sprint
HelpSectionPrinter is used to print the different sections in the CLIs help output. You can overwrite it with any Sprint function.
Functions ¶
func FlagErrorFunc ¶ added in v0.1.0
FlagErrorFunc is a drop in replacement for spf13/cobra `FlagErrorFunc`
func GenerateMarkdownDocs ¶ added in v0.1.0
GenerateMarkdownDocs walks trough every subcommand of rootCmd and creates a documentation written in Markdown for it.
func GlobalNormalizationFunc ¶ added in v0.1.0
func GlobalNormalizationFunc(rootCmd *cobra.Command) func(f *pflag.FlagSet, name string) pflag.NormalizedName
GlobalNormalizationFunc is a drop in replacement for spf13/cobra `GlobalNormalizationFunc`
func HelpTemplate ¶ added in v0.1.0
HelpTemplate is a drop in replacement for spf13/cobra `HelpTemplate`
func UsageTemplate ¶ added in v0.1.0
UsageTemplate is a drop in replacement for spf13/cobra `UsageTemplate`
func VersionTemplate ¶ added in v0.1.0
VersionTemplate is a drop in replacement for spf13/cobra `VersionTemplate`
Types ¶
This section is empty.
Source Files