id | title | desc | updated | created |
---|---|---|---|---|
Getting Started in CLI |
Writing Dendron notes with vim and cli |
So you want to write notes in dendron without installing [[Visual Studio Code]]? Me too! I love [[vim]], so I wanted to be able to use dendron from there. Here's how I did it with [[node]] from the [[command line]].
- patience
- node.js and npm
- vim (or your preferred editor.)
mkdir workspace
dendron workspace init --wsRoot workspace/
cd workspace
mkdir vault
dendron vault create --vaultPath vault
cd vault
dendron note lookup --query title # produces title.md you can edit
-
I can't install patience for you, try working with [[Windows]] for years.
-
Assuming you have a recent version of node/npm installed, get dendron:
npm install -g @dendronhq/dendron-cli
-
Once the software is in place, we can get going.
-
Create an empty workspace directory, e.g.
notes
.mkdir notes
-
Run the
workspace init
command, specifying the path towsRoot
.dendron workspace init --wsRoot notes/
The CLI will create the necessary configuration files in
notes
:$ ls -la notes/ total 344 drwxrwxr-x 2 user user 4096 Nov 20 11:08 . drwx------ 85 user user 307200 Nov 20 11:08 .. -rw-rw-r-- 1 user user 5 Nov 20 11:08 .dendron.port -rw-rw-r-- 1 user user 57 Nov 20 11:08 .dendron.ws -rw-rw-r-- 1 user user 1905 Nov 20 11:08 dendron.yml
.dendron.port
contains what seems to be a port number..dendron.ws
contains a JSON object with API version and timestamp.dendron.yml
contains lots of configuration details, we'll skip that for now.At this point, we are ready to create a vault that stores our notes.
Dendron stores notes in vaults, so you will have to create one yourself.
-
Create an empty vault directory inside the workspace, e.g.
topic
.cd notes mkdir topic
-
Run the
vault create
command, specifying the path towsRoot
.dendron vault create --vaultPath topic
The CLI will create the necessary configuration files in
topic
:$ ls -la topic/ total 32 drwxrwxr-x 2 user user 4096 Nov 20 13:45 . drwxrwxr-x 3 user user 4096 Nov 20 13:44 .. -rw-rw-r-- 1 user user 318 Nov 20 13:45 root.md -rw-rw-r-- 1 user user 95 Nov 20 13:45 root.schema.yml
Here we can start writing notes. About time!
Within a vault, e.g. notes/topic/
, you should see a root.md
as above.
Now you just need to create a note and ...
-
Inside a vault, create the note.
cd topic dendron note lookup --query ${note_title}
NOTE (heh): the first time you do this from command line, it is hella spammy. Be prepared to see lots of JSON, as it shows you full context of where the note is, and tries to find a workspace file in the current directory.
-
Once it's done, you can edit the note in your favourite editor:
vim $(note_title}.md
When you next call
dendron note lookup --query ${note_title}
, the updated note content is shown in a JSON object.