id          = "dnote"
name        = "Dnote"
homepage    = "https://www.getdnote.com"
description = "A command-line notebook for programmers."
executables      = ["dnote"]

[dotfiles]

# Dnote's official CLI configuration documentation names this XDG path and
# says the database is separate user data; only the hand-edited config belongs
# here.  https://www.getdnote.com/docs/cli/configuration/
paths   = ["[configHome]/dnote/dnoterc"]
exclude = []
secret  = []
side_effect = false

[commands]
format = 1
label = "Dnote"
description = "Add, search and view notes. Sync, login, edit and remove are left out."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false }

[[commands.subcommand]]
path = ["add"]
label = "Add a note"

[[commands.subcommand.source]]
id = "src"
kind = "help"
url = "https://github.com/dnote/dnote/blob/master/pkg/cli/cmd/add/add.go"
evidence = """
Use:     "add <book>",
Short:   "Add a new note",
f.StringVarP(&contentFlag, "content", "c", "", "The new content for the note")
(cobra flags: -c, --content string   The new content for the note)
"""

[[commands.subcommand.field]]
id = "book"
label = "Book"
type = "string"
position = 0
sources = ["src"]

[[commands.subcommand.field]]
id = "content"
label = "Content"
description = "Leave empty to open your editor."
type = "string"
option = ["--content", "-c"]
sources = ["src"]

[[commands.subcommand.task]]
id = "add"
label = "Add a note"
fields = ["book", "content"]
required = ["book"]

[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["book", "content"]

[[commands.subcommand]]
path = ["find"]
label = "Find notes"

[[commands.subcommand.source]]
id = "src"
kind = "help"
url = "https://github.com/dnote/dnote/blob/master/pkg/cli/cmd/find/find.go"
evidence = """
Use:     "find",
Short:   "Find notes by keywords",
f.StringVarP(&bookName, "book", "b", "", "book name to find notes in")
(cobra flags: -b, --book string   book name to find notes in)
"""

[[commands.subcommand.field]]
id = "query"
label = "Keywords"
type = "string"
position = 0
sources = ["src"]

[[commands.subcommand.field]]
id = "book"
label = "Only in book"
type = "string"
option = ["--book", "-b"]
sources = ["src"]

[[commands.subcommand.task]]
id = "find"
label = "Search notes"
fields = ["query", "book"]
required = ["query"]

[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["query", "book"]

[[commands.subcommand]]
path = ["view"]
label = "View books or notes"

[[commands.subcommand.source]]
id = "src"
kind = "help"
url = "https://github.com/dnote/dnote/blob/master/pkg/cli/cmd/view/view.go"
evidence = """
Use:     "view <book name?> <note index?>",
Short:   "List books, notes or view a content",
f.BoolVarP(&nameOnly, "name-only", "", false, "print book names only")
f.BoolVarP(&contentOnly, "content-only", "", false, "print the note content only")
(cobra flags: --name-only   print book names only; --content-only   print the note content only)
"""

[[commands.subcommand.field]]
id = "book"
label = "Book"
description = "Omit to list all books."
type = "string"
position = 0
sources = ["src"]

[[commands.subcommand.field]]
id = "index"
label = "Note index"
type = "integer"
position = 1
sources = ["src"]

[[commands.subcommand.field]]
id = "name_only"
label = "Book names only"
type = "boolean"
option = ["--name-only"]
sources = ["src"]

[[commands.subcommand.field]]
id = "content_only"
label = "Content only"
type = "boolean"
option = ["--content-only"]
sources = ["src"]

[[commands.subcommand.task]]
id = "books"
label = "List books"
fields = ["name_only"]
required = []

[[commands.subcommand.task]]
id = "note"
label = "Show a note"
fields = ["book", "index", "content_only"]
required = ["book", "index"]

[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["book", "index", "name_only", "content_only"]