CLI

Summary

The Dendron CLI exposes Dendron's functionality via the command line.

Setup

Install Node.js

There are several approaches that can be taken to install Node.js to your desktop. Select one of the following:

Install dendron-cli

npm install -g @dendronhq/dendron-cli@latest

Local Insallation

If dendron-cli is installed in the local directory via npm

  • Creates a package.json and package-lock.json
  • dendron-cli is only accessible in the directory this is ran in
  • dendron commands must be run like: npx dendron <cmd>
  • This is best practice for repos doing publishing, etc.
npm install @dendronhq/dendron-cli@latest

Common Options

wsRoot

This only needs to be set if you are not executing the CLI from within the root of your workspace or in a subdirectory of an existing workspace

vault

Path to a vaults. If not given and not a multi vault workspace, Dendron will use the only existing vault. Otherwise, will ask for you to specify a vault

useLocalEngine

Runs the command called using the in memory engine instead of connecting to a server.

Debug Mode

To enable debug logging, set LOG_LEVEL to debug.

LOG_LEVEL=debug dendron {your-command}

Children
  1. Upgrade

Backlinks