Merge pull request #135 from StackVista/STAC-24007

STAC-24007: Remove repetitions from Usage descriptions

Author: fvlankvelt

AGENTS.md

@@ -16,7 +16,7 @@ type DeleteArgs struct {
 func DeleteCommand(cli *di.Deps) *cobra.Command {
 	args := &DeleteArgs{}
 	cmd := &cobra.Command{
-		Use:   "delete --name NAME",
+		Use:   "delete",
 		Short: "Delete a saved context from the CLI configuration",
 		Long:  "Delete a connection context from the CLI configuration file. The currently active context cannot be deleted; switch to a different context first.",
 		Example: `# delete an unused context

cmd/context/context_delete.go

@@ -30,7 +30,7 @@ type SaveArgs struct {
 func SaveCommand(cli *di.Deps) *cobra.Command {
 	args := &SaveArgs{}
 	cmd := &cobra.Command{
-		Use:   "save --url URL {--api-token TOKEN | --service-token TOKEN}",
+		Use:   "save",
 		Short: "Save a connection context to the CLI configuration",
 		Long:  `Save a connection context to the CLI configuration file. The context stores the server URL and authentication credentials. After saving, this context becomes the current active context.`,
 		Example: `# save a context with an API token

cmd/context/context_save.go

@@ -16,7 +16,7 @@ type SetArgs struct {
 func SetCommand(cli *di.Deps) *cobra.Command {
 	args := &SetArgs{}
 	cmd := &cobra.Command{
-		Use:   "set --name NAME",
+		Use:   "set",
 		Short: "Set the active context to use for CLI commands",
 		Long:  "Set the active connection context. All subsequent CLI commands will use this context's server URL and credentials.",
 		Example: `# switch to the production context

cmd/context/context_set.go

@@ -14,7 +14,7 @@ type ValidateArgs struct {
 func ValidateCommand(cli *di.Deps) *cobra.Command {
 	args := &ValidateArgs{}
 	cmd := &cobra.Command{
-		Use:   "validate [--name NAME]",
+		Use:   "validate",
 		Short: "Validate that a context can connect to the server",
 		Long:  "Validate a connection context by attempting to connect to the SUSE Observability server. Validates the current context if no name is specified.",
 		Example: `# validate the current context

cmd/context/context_validate.go

@@ -21,7 +21,7 @@ type ApplyArgs struct {
 func DashboardApplyCommand(cli *di.Deps) *cobra.Command {
 	args := &ApplyArgs{}
 	cmd := &cobra.Command{
-		Use:   "apply --file FILE",
+		Use:   "apply",
 		Short: "Create or update a dashboard from a YAML file",
 		Long:  "Create or update a dashboard from a YAML file. If the YAML contains an 'id' field, the existing dashboard is updated; otherwise a new dashboard is created.",
 		Example: `# create a new dashboard from file

cmd/dashboard/dashboard_apply.go

@@ -22,14 +22,14 @@ type CloneArgs struct {
 func DashboardCloneCommand(cli *di.Deps) *cobra.Command {
 	args := &CloneArgs{}
 	cmd := &cobra.Command{
-		Use:   "clone {--id ID | --identifier URN} --name NAME",
+		Use:   "clone",
 		Short: "Clone an existing dashboard to create a new copy",
 		Long:  "Clone an existing dashboard to create a new copy with a different name. Optionally set a new description and scope for the cloned dashboard.",
 		Example: `# clone a dashboard by ID
 sts dashboard clone --id 123456789 --name My Dashboard Copy
 
 # clone a dashboard as private
-sts dashboard clone --identifier urn:stackpack:my-dashboard --name Private Copy --scope privateDashboard`,
+sts dashboard clone --identifier urn:stackpack:my-dashboard --name "Private Copy" --scope privateDashboard`,
 		RunE: cli.CmdRunEWithApi(RunDashboardCloneCommand(args)),
 	}
 

cmd/dashboard/dashboard_clone.go

@@ -19,7 +19,7 @@ type DeleteArgs struct {
 func DashboardDeleteCommand(cli *di.Deps) *cobra.Command {
 	args := &DeleteArgs{}
 	cmd := &cobra.Command{
-		Use:   "delete {--id ID | --identifier URN}",
+		Use:   "delete",
 		Short: "Delete a dashboard permanently",
 		Long:  "Delete a dashboard by its ID or identifier. Only user-owned dashboards can be deleted.",
 		Example: `# delete a dashboard by ID

cmd/dashboard/dashboard_delete.go

@@ -21,7 +21,7 @@ type DescribeArgs struct {
 func DashboardDescribeCommand(cli *di.Deps) *cobra.Command {
 	args := &DescribeArgs{}
 	cmd := &cobra.Command{
-		Use:   "describe {--id ID | --identifier URN}",
+		Use:   "describe",
 		Short: "Export a dashboard definition in YAML format",
 		Long:  "Export the full dashboard definition in YAML format. Output can be printed to stdout or saved to a file for backup or migration purposes.",
 		Example: `# describe a dashboard by ID

cmd/dashboard/dashboard_describe.go

@@ -21,7 +21,7 @@ type EditArgs struct {
 func DashboardEditCommand(cli *di.Deps) *cobra.Command {
 	args := &EditArgs{}
 	cmd := &cobra.Command{
-		Use:   "edit {--id ID | --identifier URN}",
+		Use:   "edit",
 		Short: "Edit a dashboard interactively in your default editor",
 		Long:  "Edit a dashboard interactively. Opens the dashboard YAML in the editor defined by your EDITOR environment variable. Changes are applied when you save and close the editor.",
 		Example: `# edit a dashboard by ID