carapace: updated command descriptions

carapace-sh · Mar 1, 2024 · 13e8edd · 13e8edd
1 parent de860c8
commit 13e8edd
Show file tree

Hide file tree

Showing 9 changed files with 16 additions and 17 deletions.
diff --git a/cmd/carapace/cmd/clearCache.go b/cmd/carapace/cmd/clearCache.go
@@ -10,14 +10,13 @@ import (
 
 var clearCacheCmd = &cobra.Command{
 	Use:   "--clear-cache",
-	Short: "",
+	Short: "clear caches",
 	RunE: func(cmd *cobra.Command, args []string) error {
 		cacheDir, err := xdg.UserCacheDir()
 		if err != nil {
 			return err
 		}
-		path := cacheDir + "/carapace"
-		return os.RemoveAll(path)
+		return os.RemoveAll(cacheDir + "/carapace")
 	},
 }
 

diff --git a/cmd/carapace/cmd/codegen.go b/cmd/carapace/cmd/codegen.go
@@ -6,8 +6,8 @@ import (
 )
 
 var codegenCmd = &cobra.Command{
-	Use:   "--codegen [spec]",
-	Short: "",
+	Use:   "--codegen spec",
+	Short: "generate code for spec file",
 	Args:  cobra.MinimumNArgs(1),
 	RunE: func(cmd *cobra.Command, args []string) error {
 		return codegen(args[0])

diff --git a/cmd/carapace/cmd/diff.go b/cmd/carapace/cmd/diff.go
@@ -15,8 +15,8 @@ import (
 )
 
 var diffCmd = &cobra.Command{
-	Use:   "--diff",
-	Short: "",
+	Use:   "--diff command[/bridge] ...args",
+	Short: "diff completion",
 	Args:  cobra.MinimumNArgs(2),
 	RunE: func(cmd *cobra.Command, args []string) error {
 		var stdout, stderr bytes.Buffer

diff --git a/cmd/carapace/cmd/list.go b/cmd/carapace/cmd/list.go
@@ -16,7 +16,7 @@ import (
 
 var listCmd = &cobra.Command{
 	Use:   "--list",
-	Short: "",
+	Short: "list completers",
 	Args:  cobra.ArbitraryArgs,
 	Run: func(cmd *cobra.Command, args []string) {
 		switch cmd.Flag("format").Value.String() {

diff --git a/cmd/carapace/cmd/macro.go b/cmd/carapace/cmd/macro.go
@@ -15,8 +15,8 @@ import (
 )
 
 var macroCmd = &cobra.Command{
-	Use:   "--macro [macro] ...",
-	Short: "",
+	Use:   "--macro [macro] [...args]",
+	Short: "list or execute macros",
 	Args:  cobra.ArbitraryArgs,
 	Run: func(cmd *cobra.Command, args []string) {
 		switch len(args) {

diff --git a/cmd/carapace/cmd/macros_test.go b/cmd/carapace/cmd/macros_test.go
@@ -13,6 +13,6 @@ func TestMacros(t *testing.T) {
 			Expect(carapace.ActionStyledValues(
 				"Green", "color2",
 				"Grey", "color8",
-			).Usage("--macro [macro] ..."))
+			).Usage("--macro [macro] [...args]"))
 	})
 }
diff --git a/cmd/carapace/cmd/run.go b/cmd/carapace/cmd/run.go
@@ -10,8 +10,8 @@ import (
 )
 
 var runCmd = &cobra.Command{
-	Use:   "--run",
-	Short: "",
+	Use:   "--run spec ...args",
+	Short: "run spec",
 	Args:  cobra.MinimumNArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
 		_, spec, err := loadSpec(args[0])

diff --git a/cmd/carapace/cmd/schema.go b/cmd/carapace/cmd/schema.go
@@ -9,8 +9,8 @@ import (
 )
 
 var schemaCmd = &cobra.Command{
-	Use:   "--codegen",
-	Short: "",
+	Use:   "--codegen spec",
+	Short: "json schema for spec files",
 	Run: func(cmd *cobra.Command, args []string) {
 		if schema, err := spec.Schema(); err != nil {
 			fmt.Fprintln(cmd.ErrOrStderr(), err.Error()) // TODO fail / exit 1 ?

diff --git a/cmd/carapace/cmd/style.go b/cmd/carapace/cmd/style.go
@@ -10,8 +10,8 @@ import (
 )
 
 var styleCmd = &cobra.Command{
-	Use:   "--style [config]",
-	Short: "",
+	Use:   "--style key=value",
+	Short: "set style",
 	Args:  cobra.MinimumNArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
 		if err := setStyle(args[0]); err != nil {