Categorygithub.com/pterm/pcli
modulepackage
0.4.6
Repository: https://github.com/pterm/pcli.git
Documentation: pkg.go.dev

# README

PCLI ✨

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

# Functions

CheckForUpdates checks if a new version of your application is pushed, and notifies the user, if DisableUpdateChecking is true.
Err is a drop in replacement for spf13/cobra `Err`.
FlagErrorFunc is a drop in replacement for spf13/cobra `FlagErrorFunc`.
GenerateMarkdownDoc walks trough every subcommand of rootCmd and creates a documentation written in Markdown for it.
GetCiCommand returns a custom crafted CI command.
GlobalNormalizationFunc is a drop in replacement for spf13/cobra `GlobalNormalizationFunc`.
HelpFunc is a drop in replacement for spf13/cobra `HelpFunc`.
HelpTemplate is a drop in replacement for spf13/cobra `HelpTemplate`.
PcliOut is a drop in replacement for spf13/cobra `SetOut`.
SetRepo must be set to your repository path (eg.
SetRootCmd sets your rootCmd.
Setup replaces some cobra functions with pcli functions for nicer output.
UsageFunc is a drop in replacement for spf13/cobra `UsageFunc`.
UsageTemplate is a drop in replacement for spf13/cobra `UsageTemplate`.
VersionTemplate is a drop in replacement for spf13/cobra `VersionTemplate`.

# Variables

No description provided by the author
DisableUpdateChecking automatically checks if a new version of your application is pushed, and notifies the user.
HelpSectionPrinter is used to print the different sections in the CLIs help output.

# Structs

MarkdownDocument contains the command and it's markdown documentation.