Update command descriptions

Signed-off-by: Oliver Davies <oliver@oliverdavies.uk>
This commit is contained in:
Oliver Davies 2025-09-30 00:48:16 +01:00
parent de97a22813
commit 5a64827825
6 changed files with 13 additions and 43 deletions

View file

@ -11,13 +11,8 @@ import (
var createCmd = &cobra.Command{ var createCmd = &cobra.Command{
Use: "create", Use: "create",
Aliases: []string{"c", "n", "new"}, Aliases: []string{"c", "n", "new"},
Short: "A brief description of your command", Short: "Create a new zettel",
Long: `A longer description that spans multiple lines and likely contains examples Long: `zet create|new|c|n TITLE`,
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.`,
Run: func(cmd *cobra.Command, args []string) { Run: func(cmd *cobra.Command, args []string) {
title := "" title := ""

View file

@ -13,13 +13,8 @@ import (
var editCmd = &cobra.Command{ var editCmd = &cobra.Command{
Use: "edit", Use: "edit",
Aliases: []string{"e"}, Aliases: []string{"e"},
Short: "A brief description of your command", Short: "Edit a specific zettel",
Long: `A longer description that spans multiple lines and likely contains examples Long: `zet edit|e ID`,
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.`,
Run: func(cmd *cobra.Command, args []string) { Run: func(cmd *cobra.Command, args []string) {
if len(args) < 1 { if len(args) < 1 {
fmt.Println("Error: No id provided") fmt.Println("Error: No id provided")

View file

@ -12,13 +12,8 @@ import (
var findCmd = &cobra.Command{ var findCmd = &cobra.Command{
Use: "find", Use: "find",
Aliases: []string{"f", "s", "search"}, Aliases: []string{"f", "s", "search"},
Short: "A brief description of your command", Short: "Print IDs and titles of zettels matching QUERY",
Long: `A longer description that spans multiple lines and likely contains examples Long: `zet find QUERY`,
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.`,
Run: func(cmd *cobra.Command, args []string) { Run: func(cmd *cobra.Command, args []string) {
if len(args) < 1 { if len(args) < 1 {
fmt.Println("No query") fmt.Println("No query")

View file

@ -9,13 +9,8 @@ import (
// rootCmd represents the base command when called without any subcommands // rootCmd represents the base command when called without any subcommands
var rootCmd = &cobra.Command{ var rootCmd = &cobra.Command{
Use: "zet", Use: "zet",
Short: "A brief description of your application", Short: "Zettlekasten note manager",
Long: `A longer description that spans multiple lines and likely contains Long: `Zettlekasten note manager`,
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.`,
// Uncomment the following line if your bare application // Uncomment the following line if your bare application
// has an action associated with it: // has an action associated with it:
// Run: func(cmd *cobra.Command, args []string) { }, // Run: func(cmd *cobra.Command, args []string) { },

View file

@ -7,15 +7,10 @@ import (
) )
var titlesCmd = &cobra.Command{ var titlesCmd = &cobra.Command{
Use: "titles", Use: "titles",
Aliases: []string{"t"}, Aliases: []string{"t"},
Short: "A brief description of your command", Short: "Print IDs and titles of zettels",
Long: `A longer description that spans multiple lines and likely contains examples Long: `Print the IDs and titles of all zettels.`,
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.`,
Run: func(cmd *cobra.Command, args []string) { Run: func(cmd *cobra.Command, args []string) {
zets := lib.GetAllZets() zets := lib.GetAllZets()

View file

@ -13,13 +13,8 @@ import (
var viewCmd = &cobra.Command{ var viewCmd = &cobra.Command{
Use: "view", Use: "view",
Aliases: []string{"v"}, Aliases: []string{"v"},
Short: "A brief description of your command", Short: "View a specific zettel",
Long: `A longer description that spans multiple lines and likely contains examples Long: `zet view|v ID`,
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.`,
Run: func(cmd *cobra.Command, args []string) { Run: func(cmd *cobra.Command, args []string) {
if len(args) < 1 { if len(args) < 1 {
fmt.Println("Error: No id provided") fmt.Println("Error: No id provided")