methods on Dendrite

vault commands

Mon, 01 Jan 0001 00:00:00 +0000

vault commands#

Vault commands manage the daemon’s connection to a vault and its index. vault/init must be called before any other command — it is what binds the daemon instance to a vault.

vault/init#

Initializes the daemon against a vault. This sets up the database context and, if the vault has not been indexed before, performs a full index build by scanning the vault directory.

If the index already contains notes the rebuild is skipped, so calling vault/init on an already-known vault is safe and cheap.

note commands

Mon, 01 Jan 0001 00:00:00 +0000

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:

Field	Type	Description
`title`	string	Title for the new note. Used in frontmatter and converted to a slug for the filename.
`templateName`	string	Name of the template the note will use.
`directory`	string	The directory the note will be placed in, relative to the vault root.

Request:

completion commands

Mon, 01 Jan 0001 00:00:00 +0000

completion commands#

Completion commands are designed to feed editor completion engines. Both accept a partial query and return a list of matching strings, using a substring match against the index.

completion/slug#

Returns a list of note slugs whose title, path, or slug contains the query string. Intended to power [[link]] completion in the client editor.

Method: completion/slug

Params:

Field	Type	Description
`query`	string	Partial string to match against note title, path, and slug.

Request:

queries

Mon, 01 Jan 0001 00:00:00 +0000

queries#

Queries read from the index without modifying it. They are used for navigation, discovery, and search.

goto note#

Supplied with a valid link, returns a target and a type. The target is what the client should navigate to. The type indicates whether the link points to another note within the vault or to an external URL. See links for details.

Method: note/goto

Params:

Field	Type	Description
`link`	string	A link extracted from a note.

Request:

diagnostics

Mon, 01 Jan 0001 00:00:00 +0000

diagnostics#

Diagnostic commands inspect the index for inconsistencies without modifying it. They are intended to help clients surface problems to the user in real time.

diagnostics/links#

Scans the links recorded for a given note and returns any that point to a slug that does not exist in the index. Intended to be called after a note is saved or opened so clients can display inline warnings.

Method: diagnostics/links

Params:

Field	Type	Description
`path`	string	Absolute path to the note to check.

Request: