Skip to content

Commit bda7e5c

Browse files
authored
Merge pull request #7522 from chiukapoor/improve-usage-text
🌱 Improved the usage to reflect the required arguments in `generate cluster`, `describe cluster` and `get kubeconfig`
2 parents 7662604 + 4f29c50 commit bda7e5c

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

cmd/clusterctl/cmd/describe_cluster.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ type describeClusterOptions struct {
7171
var dc = &describeClusterOptions{}
7272

7373
var describeClusterClusterCmd = &cobra.Command{
74-
Use: "cluster",
74+
Use: "cluster NAME",
7575
Short: "Describe workload clusters",
7676
Long: LongDesc(`
7777
Provide an "at glance" view of a Cluster API cluster designed to help the user in quickly

cmd/clusterctl/cmd/generate_cluster.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ type generateClusterOptions struct {
4747
var gc = &generateClusterOptions{}
4848

4949
var generateClusterClusterCmd = &cobra.Command{
50-
Use: "cluster",
50+
Use: "cluster NAME",
5151
Short: "Generate templates for creating workload clusters",
5252
Long: LongDesc(`
5353
Generate templates for creating workload clusters.

cmd/clusterctl/cmd/get_kubeconfig.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ type getKubeconfigOptions struct {
3535
var gk = &getKubeconfigOptions{}
3636

3737
var getKubeconfigCmd = &cobra.Command{
38-
Use: "kubeconfig",
38+
Use: "kubeconfig NAME",
3939
Short: "Gets the kubeconfig file for accessing a workload cluster",
4040
Long: LongDesc(`
4141
Gets the kubeconfig file for accessing a workload cluster`),

0 commit comments

Comments
 (0)