Note Commands

Synopsis

dendron note <cmd>

note related commands

Positionals:
  cmd  a command to run        [string] [required] [choices: "lookup", "delete"]

Options:
  --version         Show version number                                [boolean]
  --help            Show help                                          [boolean]
  --wsRoot          location of workspace
  --vault           name of vault
  --quiet           don't print output to stdout
  --enginePort      If set, connect to to running engine. If not set, create new
                    instance of Dendron Engine
  --useLocalEngine  If set, use in memory engine instead of connecting to a
                    server                                             [boolean]
  --query           the query to run                                    [string]

Methods

lookup

Options

  • for common options, see common options
  • --output: controls how note is formatted
    • values: json|md_gfm|md_dendron
      • json: JSON output
      • md_dendron: dendron markdown
      • md_gfm: github flavored markdown

Examples

creating a note

# creates hello if it does not exist
dendron note lookup --query "hello" 

Querying a note

# retrieves hello.md if it does exist
dendron note lookup --query "hello" 

Querying a note with GitHub Flavored Markdown output

# retrieves hello.md if it does exist
dendron note lookup --query "hello" --output md_gfm

delete

Examples

Deleting a note

dendron note delete --query "foo" 

Deleting a note within a multi-vault workspace

dendron note delete --vault vault2 --query "foo"