Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Edit ¶
type Edit struct { Force bool `short:f help:"Do not confirm before editing many notes at the same time."` cli.Filtering }
Edit opens notes matching a set of criteria with the user editor.
type Graph ¶ added in v0.8.0
type Graph struct { Format string `group:format short:f help:"Format of the graph among: json." enum:"json" required` Quiet bool `group:format short:q help:"Do not print the total number of notes found."` cli.Filtering }
Graph produces a directed graph of the notes matching a set of criteria.
type Index ¶
type Index struct { Force bool `short:"f" help:"Force indexing all the notes."` Verbose bool `short:"v" help:"Print detailed information about the indexing process."` Quiet bool `short:"q" help:"Do not print statistics nor progress."` }
Index indexes the content of all the notes in the notebook.
type Init ¶
type Init struct {
Directory string `arg optional type:"path" default:"." help:"Directory containing the notebook."`
}
Init creates a notebook in the given directory
type LSP ¶
type LSP struct {
Log string `hidden type:path placeholder:PATH help:"Absolute path to the log file"`
}
LSP starts a server implementing the Language Server Protocol.
type List ¶
type List struct { Format string `` /* 179-byte string literal not displayed */ Header string `group:format help:"Arbitrary text printed at the start of the list."` Delimiter string "group:format short:d default:\n help:\"Print notes delimited by the given separator.\"" Delimiter0 bool "" /* 156-byte string literal not displayed */ NoPager bool `group:format short:P help:"Do not pipe output into a pager."` Quiet bool `group:format short:q help:"Do not print the total number of notes found."` cli.Filtering }
List displays notes matching a set of criteria.
type New ¶
type New struct { Directory string `arg optional default:"." help:"Directory in which to create the note."` Title string `short:t placeholder:TITLE help:"Title of the new note."` Group string `` /* 132-byte string literal not displayed */ Extra map[string]string ` help:"Extra variables passed to the templates." mapsep:","` Template string ` placeholder:PATH help:"Custom template used to render the note."` PrintPath bool `short:p help:"Print the path of the created note instead of editing it."` DryRun bool `` /* 138-byte string literal not displayed */ }
New adds a new note to the notebook.
type Tag ¶ added in v0.7.0
type Tag struct {
List TagList `cmd group:"cmd" default:"withargs" help:"List all the note tags."`
}
Tag manages the note tags in the notebook.
type TagList ¶ added in v0.7.0
type TagList struct { Format string `` /* 155-byte string literal not displayed */ Header string `group:format help:"Arbitrary text printed at the start of the list."` Delimiter string "group:format short:d default:\n help:\"Print tags delimited by the given separator.\"" Delimiter0 bool "" /* 155-byte string literal not displayed */ NoPager bool `group:format short:P help:"Do not pipe output into a pager."` Quiet bool `group:format short:q help:"Do not print the total number of tags found."` Sort []string `group:sort short:s placeholder:TERM help:"Order the tags by the given criterion."` }
TagList lists all the note tags.
Click to show internal directories.
Click to hide internal directories.