Pod CLI
Summary
CLI commands for interacting with pods
NOTE: you can find pod ids in the pods page
Usage
Commands
Export Pod
From Export Pod CLI
Go to text →
Summary
Use pods to export your notes to another pod type
Usage
Actions
The below provide an overview of the purpose of action the doctor command can run.
use a pod to export notes
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
  --attach          Use existing engine instead of spawning a new one
  --useLocalEngine  If set, use in memory engine instead of connecting to a
                    server                                             [boolean]
  --podId           id of pod to use
  --showConfig      show pod configuration
  --genConfig       show pod configuration
  --podPkg          if specifying a custom pod, name of pkg
  --config          pass in config instead of reading from file. format is comma
                    delimited {key}={value} pairs
  --podSource       podSource[choices: "custom", "builtin"] [default: "builtin"]
Examples
- export note to a JSONpod
 
dendron exportPod --podId dendron.json --wsRoot . 
Import Pod
From Import Pod CLI
Go to text →
Summary
Use pods to import your notes from another pod type
Usage
use a pod to import notes
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
  --attach          Use existing engine instead of spawning a new one
  --useLocalEngine  If set, use in memory engine instead of connecting to a
                    server                                             [boolean]
  --podId           id of pod to use
  --showConfig      show pod configuration
  --genConfig       show pod configuration
  --podPkg          if specifying a custom pod, name of pkg
  --config          pass in config instead of reading from file. format is comma
                    delimited {key}={value} pairs
  --podSource       podSource[choices: "custom", "builtin"] [default: "builtin"]
Examples
- Import notes from FilePod
 
dendron importPod --podId dendron.markdown --wsRoot . 
Publish Pod
From Publish Pod CLI
Go to text →
Summary
Publish a note to a pod
Usage
publish a note
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
  --attach          Use existing engine instead of spawning a new one
  --useLocalEngine  If set, use in memory engine instead of connecting to a
                    server                                             [boolean]
  --podId           id of pod to use
  --showConfig      show pod configuration
  --genConfig       show pod configuration
  --podPkg          if specifying a custom pod, name of pkg
  --config          pass in config instead of reading from file. format is comma
                    delimited {key}={value} pairs
  --podSource       podSource[choices: "custom", "builtin"] [default: "builtin"]
Options
--query
Name of note to publish
Examples
- Publish 
dendron.mdnote as Markdown 
dendron publishPod --wsRoot . --podId dendron.markdown --query dendron
Common Options
--configPath
Path to a custom yml configuration for the pod
Backlinks