pcli

package module
v0.2.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 14, 2021 License: MIT Imports: 13 Imported by: 40

README

PCLI ✨

PCLI is a custom Go module for pterm/cli-template, which handles all of its logic.

Documentation

Index

Constants

This section is empty.

Variables

View Source
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

func FlagErrorFunc() func(*cobra.Command, error) error

FlagErrorFunc is a drop in replacement for spf13/cobra `FlagErrorFunc`

func GenerateMarkdownDocs added in v0.1.0

func GenerateMarkdownDocs(command *cobra.Command) (markdown []string)

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() func(f *pflag.FlagSet, name string) pflag.NormalizedName

GlobalNormalizationFunc is a drop in replacement for spf13/cobra `GlobalNormalizationFunc`

func HelpFunc added in v0.1.0

func HelpFunc() func(*cobra.Command, []string)

HelpFunc is a drop in replacement for spf13/cobra `HelpFunc`

func HelpTemplate added in v0.1.0

func HelpTemplate() string

HelpTemplate is a drop in replacement for spf13/cobra `HelpTemplate`

func SetRootCmd added in v0.2.0

func SetRootCmd(cmd *cobra.Command)

SetRootCmd sets your rootCmd.

func UsageFunc added in v0.1.0

func UsageFunc() func(*cobra.Command) error

UsageFunc is a drop in replacement for spf13/cobra `UsageFunc`

func UsageTemplate added in v0.1.0

func UsageTemplate() string

UsageTemplate is a drop in replacement for spf13/cobra `UsageTemplate`

func VersionTemplate added in v0.1.0

func VersionTemplate() string

VersionTemplate is a drop in replacement for spf13/cobra `VersionTemplate`

Types

This section is empty.

Jump to

Keyboard shortcuts

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