1. installation#

Installing dendrite.daemon is a prerequisite to any client working, as they depend on the daemon.

1.1 requirements#

2. install the daemon#

Run the install script. It will detect your OS and CPU architecture, download the correct binary from the latest release, and place it on your PATH.

curl -fsSL https://raw.githubusercontent.com/KristianJBorgwarth/dendrite.daemon/master/install.sh | sh

On Linux the binary is placed in ~/.local/bin. On macOS it goes to /usr/local/bin.

If the install directory is not on your PATH the script will tell you and show you what to add to your shell profile.

To update the daemon later, re-run the same command.

3. install the Neovim plugin#

Add dendrite.nvim to your plugin manager. Example using lazy.nvim:

{
  "KristianJBorgwarth/dendrite.nvim",
  dependencies = {
    "nvim-telescope/telescope.nvim",
    "nvim-lua/plenary.nvim",
  },
  config = function()
    require("dendrite").setup({
      vault_name = "atlas",
      vault_path = "~/notes/atlas",
      templates_dir = "~/notes/atlas/.templates",
      scratch_notes = {
        dir = "~/notes/atlas/scratches",
        template_name = "scratch",
      },
      daily_notes = {
        dir = "~/notes/atlas/daily",
        filename_format = "%Y-%m-%d.md",
        template_name = "daily",
      },
    })
  end,
}

nvim-cmp is an optional dependency. If it is installed, the plugin will register a completion source for slug and tag completion inside markdown files. See completion for details.

3.1 configure your vault#

The vault_name and vault_path options are the only required fields. Everything else has sensible defaults. See the full configuration reference for all available options.

The vault directory must exist before starting Neovim. The daemon will scan it on first launch and build the index automatically.