note commands#

Note commands modify the index by creating or updating notes.

create note#

Creates a note at a specified directory, and updates the index. Returns the path to the created note. The note content is generated from a template.

Method: note/create

Params:

Request:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "note/create",
  "params": {
    "title": "dendrite is helping my workflow",
    "templateName": "log",
    "directory": "worklogs"
  }
}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": "~/vault/worklogs/dendrite-is-helping-my-workflow.md"
}

The client can then open the newly created note in a buffer.

save note#

Reads the note corresponding to the supplied path. Wipes the note from the index, if it exists, and does a reindex of the note.

Method: note/save

Params:

Request:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "note/save",
  "params": {
    "path": "~/vault/worklogs/dendrite-is-helping-my-workflow.md"
  }
}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": null
}

delete note#

Removes a note from the index along with all its associated metadata (links and tags). The note file itself is not deleted from disk.

This command is intended for callers that have their own file-deletion mechanism and can issue the command immediately after deleting a file. Clients that cannot reliably hook into file deletion should use vault/rebuild to re-sync the index instead.

Method: note/delete

Params:

Request:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "note/delete",
  "params": {
    "path": "~/vault/worklogs/dendrite-is-helping-my-workflow.md"
  }
}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": null
}