Skip to content

Commit 79ecf96

Browse files
committed
follow best practice for help output
1 parent afca48c commit 79ecf96

File tree

2 files changed

+33
-26
lines changed

2 files changed

+33
-26
lines changed

cmd/plugin/cli/root.go

+28-21
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,46 @@
11
package cli
22

33
import (
4-
"os"
5-
"strings"
4+
"os"
5+
"path/filepath"
6+
"strings"
67

7-
"github.com/spf13/cobra"
8-
"github.com/spf13/viper"
9-
"k8s.io/cli-runtime/pkg/genericclioptions"
8+
"github.com/spf13/cobra"
9+
"github.com/spf13/viper"
10+
"k8s.io/cli-runtime/pkg/genericclioptions"
1011
)
1112

1213
var (
13-
KubernetesConfigFlags *genericclioptions.ConfigFlags
14+
KubernetesConfigFlags *genericclioptions.ConfigFlags
1415
)
1516

1617
func RootCmd() *cobra.Command {
17-
cmd := &cobra.Command{
18-
Use: "pv-mounter",
19-
Short: "A plugin to mount and clean PVCs",
20-
Long: `A plugin to mount and clean PVCs using SSHFS.`,
21-
}
18+
cmd := &cobra.Command{
19+
Use: "pv-mounter",
20+
Short: "A tool to mount and unmount PVs",
21+
Long: `A tool to mount and unmount PVs using SSHFS.`,
22+
}
2223

23-
cmd.AddCommand(mountCmd())
24-
cmd.AddCommand(cleanCmd())
24+
if strings.HasPrefix(filepath.Base(os.Args[0]), "kubectl-") {
25+
cmd.Use = "kubectl pv-mounter [flags]"
26+
}
2527

26-
return cmd
28+
cmd.AddCommand(mountCmd())
29+
cmd.AddCommand(cleanCmd())
30+
31+
return cmd
2732
}
2833

2934
func InitAndExecute() {
30-
KubernetesConfigFlags = genericclioptions.NewConfigFlags(true)
31-
KubernetesConfigFlags.AddFlags(RootCmd().PersistentFlags())
35+
KubernetesConfigFlags = genericclioptions.NewConfigFlags(true)
36+
KubernetesConfigFlags.AddFlags(RootCmd().PersistentFlags())
3237

33-
viper.AutomaticEnv()
34-
viper.SetEnvKeyReplacer(strings.NewReplacer("-", "_"))
38+
viper.AutomaticEnv()
39+
viper.SetEnvKeyReplacer(strings.NewReplacer("-", "_"))
3540

36-
if err := RootCmd().Execute(); err != nil {
37-
os.Exit(1)
38-
}
41+
if err := RootCmd().Execute(); err != nil {
42+
os.Exit(1)
43+
}
3944
}
45+
46+

deploy/krew/plugin.yaml

+5-5
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ kind: Plugin
33
metadata:
44
name: pv-mounter
55
spec:
6-
version: "v0.0.4"
6+
version: "v0.0.5"
77
platforms:
88
- selector:
99
matchLabels:
1010
os: linux
1111
arch: amd64
12-
uri: https://github.com/fenio/pv-mounter/releases/download/v0.0.4/pv-mounter_linux_amd64.tar.gz
12+
uri: https://github.com/fenio/pv-mounter/releases/download/v0.0.5/pv-mounter_linux_amd64.tar.gz
1313
sha256: ""
1414
files:
1515
- from: "./pv-mounter"
@@ -21,7 +21,7 @@ spec:
2121
matchLabels:
2222
os: linux
2323
arch: arm64
24-
uri: https://github.com/fenio/pv-mounter/releases/download/v0.0.4/pv-mounter_linux_arm64.tar.gz
24+
uri: https://github.com/fenio/pv-mounter/releases/download/v0.0.5/pv-mounter_linux_arm64.tar.gz
2525
sha256: ""
2626
files:
2727
- from: "./pv-mounter"
@@ -34,7 +34,7 @@ spec:
3434
matchLabels:
3535
os: darwin
3636
arch: amd64
37-
uri: https://github.com/fenio/pv-mounter/releases/download/v0.0.4/pv-mounter_darwin_amd64.tar.gz
37+
uri: https://github.com/fenio/pv-mounter/releases/download/v0.0.5/pv-mounter_darwin_amd64.tar.gz
3838
sha256: ""
3939
files:
4040
- from: "./pv-mounter"
@@ -46,7 +46,7 @@ spec:
4646
matchLabels:
4747
os: darwin
4848
arch: arm64
49-
uri: https://github.com/fenio/pv-mounter/releases/download/v0.0.4/pv-mounter_darwin_arm64.tar.gz
49+
uri: https://github.com/fenio/pv-mounter/releases/download/v0.0.5/pv-mounter_darwin_arm64.tar.gz
5050
sha256: ""
5151
files:
5252
- from: "./pv-mounter"

0 commit comments

Comments
 (0)