common

package

v0.12.41 Latest Latest Go to latest Published: Feb 25, 2026 License: MIT Imports: 26 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/pluralsh/plural-cli

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func Affirm(msg string, envKey string) bool
func Affirmed(fn func(*cli.Context) error, msg string, envKey string) func(*cli.Context) error
func CaptureStdout(app *cli.App, arg []string) (string, error)
func CommitMsg(c *cli.Context) string
func Confirm(msg string, envKey string) bool
func CryptoInit(_ *cli.Context) error
func EnsureGitAttributes() error
func EnsureGitIgnore() error
func GetHostnameFromURL(u string) string
func GetIdAndName(input string) (id, name *string)
func GitCommand(args ...string) *exec.Cmd
func GitConfig(name, val string) error
func HandleClone(c *cli.Context) error
func HandleDown(c *cli.Context) error
func HandleImport(c *cli.Context) error
func HandleLogin(c *cli.Context) error
func HandleUnlock(_ *cli.Context) error
func InitKubeconfig(fn func(*cli.Context) error) func(*cli.Context) error
func IsUUIDv4(input string) bool
func KubeInit(_ *cli.Context) error
func LatestVersion(fn func(*cli.Context) error) func(*cli.Context) error
func Preflights(c *cli.Context) error
func PrintListNodes(nodes *v1.NodeList) error
func RequireArgs(fn func(*cli.Context) error, args []string) func(*cli.Context) error
func RunPreflights(c *cli.Context) (providerapi.Provider, error)
func Tracked(fn func(*cli.Context) error, event string) func(*cli.Context) error
func VersionInfo(_ *cli.Context) error

Constants ¶

View Source

const (
	AffirmUp   = "" /* 139-byte string literal not displayed */
	AffirmDown = "Are you ready to destroy your plural infrastructure?  This wil destroy your management cluster, and any data stored within"
)

View Source

const (
	GitAttributesFile = ".gitattributes"
	GitIgnoreFile     = ".gitignore"
)

View Source

const Gitattributes = `` /* 287-byte string literal not displayed */

View Source

const Gitignore = `/**/.terraform
/**/.terraform*
/**/terraform.tfstate*
/bin
*~
.idea
*.swp
*.swo
.DS_STORE
.vscode
context.yaml*
temp
`

Variables ¶

View Source

var (
	Version = versionPlaceholder
	Commit  = ""
	Date    = ""
)

View Source

var (
	ErrUnlock = fmt.Errorf("could not decrypt your repo, this is likely due to using the wrong key at ~/.plural/key, the original key might be in a backup or on your previous machine")
)

Functions ¶

func Affirm ¶

func Affirm(msg string, envKey string) bool

func Affirmed ¶

func Affirmed(fn func(*cli.Context) error, msg string, envKey string) func(*cli.Context) error

func CaptureStdout ¶

func CaptureStdout(app *cli.App, arg []string) (string, error)

func CommitMsg ¶

func CommitMsg(c *cli.Context) string

func Confirm ¶

func Confirm(msg string, envKey string) bool

func CryptoInit ¶

func CryptoInit(_ *cli.Context) error

func EnsureGitAttributes ¶ added in v0.12.38

func EnsureGitAttributes() error

func EnsureGitIgnore ¶ added in v0.12.38

func EnsureGitIgnore() error

func GetHostnameFromURL ¶ added in v0.12.22

func GetHostnameFromURL(u string) string

func GetIdAndName ¶

func GetIdAndName(input string) (id, name *string)

func GitCommand ¶

func GitCommand(args ...string) *exec.Cmd

func GitConfig ¶

func GitConfig(name, val string) error

func HandleClone ¶

func HandleClone(c *cli.Context) error

func HandleDown ¶

func HandleDown(c *cli.Context) error

func HandleImport ¶

func HandleImport(c *cli.Context) error

func HandleLogin ¶

func HandleLogin(c *cli.Context) error

func HandleUnlock ¶

func HandleUnlock(_ *cli.Context) error

func InitKubeconfig ¶

func InitKubeconfig(fn func(*cli.Context) error) func(*cli.Context) error

func IsUUIDv4 ¶ added in v0.12.40

func IsUUIDv4(input string) bool

func KubeInit ¶

func KubeInit(_ *cli.Context) error

func LatestVersion ¶

func LatestVersion(fn func(*cli.Context) error) func(*cli.Context) error

func Preflights ¶

func Preflights(c *cli.Context) error

func PrintListNodes ¶

func PrintListNodes(nodes *v1.NodeList) error

func RequireArgs ¶

func RequireArgs(fn func(*cli.Context) error, args []string) func(*cli.Context) error

func RunPreflights ¶

func RunPreflights(c *cli.Context) (providerapi.Provider, error)

func Tracked ¶

func Tracked(fn func(*cli.Context) error, event string) func(*cli.Context) error

func VersionInfo ¶

func VersionInfo(_ *cli.Context) error

Types ¶

This section is empty.

Source Files ¶

View all Source files

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