jprdonnelly/steampipe
1
0
Fork 0
mirror of https://github.com/turbot/steampipe.git synced 2025-12-25 03:00:48 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update and tidy the help text. Closes #1039

Browse Source
This commit is contained in:
kaidaguerre
2021-10-22 13:27:37 +01:00
committed by GitHub
parent 8551ec9868
commit e15b78308f
10 changed files with 42 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
cmd/plugin.go
View File

@@ -21,7 +21,7 @@ import (
"github.com/turbot/steampipe/utils"
)
// pluginCmd :: Plugin management commands
// Plugin management commands
func pluginCmd() *cobra.Command {
var cmd = &cobra.Command{
@@ -52,11 +52,12 @@ Examples:
cmd.AddCommand(pluginListCmd())
cmd.AddCommand(pluginUninstallCmd())
cmd.AddCommand(pluginUpdateCmd())
cmd.Flags().BoolP(constants.ArgHelp, "h", false, "Help for plugin")
return cmd
}
// pluginInstallCmd :: Install a plugin
// Install a plugin
func pluginInstallCmd() *cobra.Command {
var cmd = &cobra.Command{
Use: "install [flags] [registry/org/]name[@version]",
@@ -80,12 +81,12 @@ Examples:
}
cmdconfig.
OnCmd(cmd)
OnCmd(cmd).
AddBoolFlag(constants.ArgHelp, "h", false, "Help for plugin install")
return cmd
}
// pluginUpdateCmd :: Update plugins
// Update plugins
func pluginUpdateCmd() *cobra.Command {
var cmd = &cobra.Command{
@@ -111,12 +112,13 @@ Examples:
cmdconfig.
OnCmd(cmd).
AddBoolFlag("all", "", false, "Update all plugins to its latest available version")
AddBoolFlag("all", "", false, "Update all plugins to its latest available version").
AddBoolFlag(constants.ArgHelp, "h", false, "Help for plugin update")
return cmd
}
// pluginListCmd :: List plugins
// List plugins
func pluginListCmd() *cobra.Command {
var cmd = &cobra.Command{
@@ -139,12 +141,13 @@ Examples:
cmdconfig.
OnCmd(cmd).
AddBoolFlag("outdated", "", false, "Check each plugin in the list for updates")
AddBoolFlag("outdated", "", false, "Check each plugin in the list for updates").
AddBoolFlag(constants.ArgHelp, "h", false, "Help for plugin list")
return cmd
}
// pluginUninstallCmd :: Uninstall a plugin
// Uninstall a plugin
func pluginUninstallCmd() *cobra.Command {
var cmd = &cobra.Command{
Use: "uninstall [flags] [registry/org/]name",
@@ -165,7 +168,8 @@ Example:
`,
}
cmdconfig.OnCmd(cmd)
cmdconfig.OnCmd(cmd).
AddBoolFlag(constants.ArgHelp, "h", false, "Help for plugin uninstall")
return cmd
}
@@ -288,7 +292,7 @@ func runPluginUpdateCmd(cmd *cobra.Command, args []string) {
}
if len(plugins) > 0 && cmdconfig.Viper().GetBool("all") {
// we can't allow update and install at the same time
// we can't allow update and install at the same time
fmt.Println()
utils.ShowError(fmt.Errorf("%s cannot be used when updating specific plugins", constants.Bold("`--all`")))
fmt.Println()