From 5a64827825af24112e79da64fdefe01a7aff7512 Mon Sep 17 00:00:00 2001 From: Oliver Davies Date: Tue, 30 Sep 2025 00:48:16 +0100 Subject: [PATCH] Update command descriptions Signed-off-by: Oliver Davies --- cmd/create.go | 9 ++------- cmd/edit.go | 9 ++------- cmd/find.go | 9 ++------- cmd/root.go | 9 ++------- cmd/titles.go | 11 +++-------- cmd/view.go | 9 ++------- 6 files changed, 13 insertions(+), 43 deletions(-) diff --git a/cmd/create.go b/cmd/create.go index e5c2fcc..c9017ad 100644 --- a/cmd/create.go +++ b/cmd/create.go @@ -11,13 +11,8 @@ import ( var createCmd = &cobra.Command{ Use: "create", Aliases: []string{"c", "n", "new"}, - Short: "A brief description of your command", - Long: `A longer description that spans multiple lines and likely contains examples -and usage of using your command. For example: - -Cobra is a CLI library for Go that empowers applications. -This application is a tool to generate the needed files -to quickly create a Cobra application.`, + Short: "Create a new zettel", + Long: `zet create|new|c|n TITLE`, Run: func(cmd *cobra.Command, args []string) { title := "" diff --git a/cmd/edit.go b/cmd/edit.go index ea5fba5..5423239 100644 --- a/cmd/edit.go +++ b/cmd/edit.go @@ -13,13 +13,8 @@ import ( var editCmd = &cobra.Command{ Use: "edit", Aliases: []string{"e"}, - Short: "A brief description of your command", - Long: `A longer description that spans multiple lines and likely contains examples -and usage of using your command. For example: - -Cobra is a CLI library for Go that empowers applications. -This application is a tool to generate the needed files -to quickly create a Cobra application.`, + Short: "Edit a specific zettel", + Long: `zet edit|e ID`, Run: func(cmd *cobra.Command, args []string) { if len(args) < 1 { fmt.Println("Error: No id provided") diff --git a/cmd/find.go b/cmd/find.go index 817b257..3cbaa1c 100644 --- a/cmd/find.go +++ b/cmd/find.go @@ -12,13 +12,8 @@ import ( var findCmd = &cobra.Command{ Use: "find", Aliases: []string{"f", "s", "search"}, - Short: "A brief description of your command", - Long: `A longer description that spans multiple lines and likely contains examples -and usage of using your command. For example: - -Cobra is a CLI library for Go that empowers applications. -This application is a tool to generate the needed files -to quickly create a Cobra application.`, + Short: "Print IDs and titles of zettels matching QUERY", + Long: `zet find QUERY`, Run: func(cmd *cobra.Command, args []string) { if len(args) < 1 { fmt.Println("No query") diff --git a/cmd/root.go b/cmd/root.go index a3d98ad..ef42625 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -9,13 +9,8 @@ import ( // rootCmd represents the base command when called without any subcommands var rootCmd = &cobra.Command{ Use: "zet", - Short: "A brief description of your application", - Long: `A longer description that spans multiple lines and likely contains -examples and usage of using your application. For example: - -Cobra is a CLI library for Go that empowers applications. -This application is a tool to generate the needed files -to quickly create a Cobra application.`, + Short: "Zettlekasten note manager", + Long: `Zettlekasten note manager`, // Uncomment the following line if your bare application // has an action associated with it: // Run: func(cmd *cobra.Command, args []string) { }, diff --git a/cmd/titles.go b/cmd/titles.go index 048253b..1c509f5 100644 --- a/cmd/titles.go +++ b/cmd/titles.go @@ -7,15 +7,10 @@ import ( ) var titlesCmd = &cobra.Command{ - Use: "titles", + Use: "titles", Aliases: []string{"t"}, - Short: "A brief description of your command", - Long: `A longer description that spans multiple lines and likely contains examples -and usage of using your command. For example: - -Cobra is a CLI library for Go that empowers applications. -This application is a tool to generate the needed files -to quickly create a Cobra application.`, + Short: "Print IDs and titles of zettels", + Long: `Print the IDs and titles of all zettels.`, Run: func(cmd *cobra.Command, args []string) { zets := lib.GetAllZets() diff --git a/cmd/view.go b/cmd/view.go index a06846b..1dc1994 100644 --- a/cmd/view.go +++ b/cmd/view.go @@ -13,13 +13,8 @@ import ( var viewCmd = &cobra.Command{ Use: "view", Aliases: []string{"v"}, - Short: "A brief description of your command", - Long: `A longer description that spans multiple lines and likely contains examples -and usage of using your command. For example: - -Cobra is a CLI library for Go that empowers applications. -This application is a tool to generate the needed files -to quickly create a Cobra application.`, + Short: "View a specific zettel", + Long: `zet view|v ID`, Run: func(cmd *cobra.Command, args []string) { if len(args) < 1 { fmt.Println("Error: No id provided")