I posted "Joplin Terminal Basics" on April 15th, 2021

Joplin's terminal view of my notebooks

Posts tools second brain joplin shell

Joplin Terminal Basics

Managing notes with Joplin's terminal mode

Look. I don't know if Joplin is going to be my note manager of choice. I don't even know if I'll still be using it next week. It's cool. I'm just not that consistent.

But there's these notes. Why not share them? Someone out there might make use of them.

Just give me a minute to turn the bullet points into sentences.

What?

Try out Joplin's terminal application for typing up and organizing quick notes.

Why?

I'm often taking notes. It's the only way I can remember the little things. You can find a note-taking app whatever your preferences are. I spend a lot of time in the terminal. I don't want to leave the terminal when deep in concentration.

Joplin has a terminal application. It also has a lovely desktop application and mobile application. But we're just looking at the terminal application.

Why not ...

Like I said: there are a lot of options. I regularly play with several of them. But for the kind of "quick get this down before I forget it?"

  • Vimwiki is hard to remember
  • Org mode is hard to learn, or at least hard to master; and the temptation to fuss around is too strong
  • Obsidian needs a desktop window
  • so does Zettlr

So for today it's Joplin.

Setup

Joplin runs on NodeJS, so install it with Volta, Yarn, NPM, or whatever you install Node stuff with.

$ volta install joplin
success: installed joplin@1.6.4 with executables: joplin

Now there's a joplin command in your path!

$ joplin

You get these four panes you can tab around in, and — look, Joplin's usage docs break it down better than I could. Go look at those.

Basic usage

Joplin has a command line mode, which you get at with the colon character :. Gonna focus on that command line mode.

The first and most important command?

:help

That gives you a list of commands, including the second most important command.

:exit

Not :quit. Not :wq. No. Joplin's terminal application is kind of inspired by Vim, but it is not Vim.

Setting up note synchronization

I've already been using Joplin elsewhere, so my first task is to configure synchronization.

The sync needs no additional arguments when used with Dropbox, lucky for me.

:sync

Joplin gives me:

  • a URL to copy and paste into the browser
  • a prompt to enter Dropbox's validation code

From there?

  1. follow the link with a Control-click (in my terminal, at least)
  2. allow the integration; Dropbox gives me a string of nonsense text
  3. copy that nonsense and paste it into Joplin's prompt

If you're me, the leftmost pane fills with folders from your previous Joplin sessions. The screenshot you already saw, pretty much.

Creating a note

:mknote "Terminal notes with Joplin"

The quotes aren't needed for single-word notes. But for multi-word notes it's either wrap it in quotes or use CamelCase.

I can see it's up there in the middle tab, but now I'm obessing over the command line mode. Is there an ls equivalent? There sure is!

: ls
Terminal notes with Joplin

Editing a note

:edit "Terminal notes with Joplin"

Joplin offers a chance to autocomplete once I type enough in. I accept that autocompletion with TAB, then hit ENTER to complete the command.

This passes the note buffer off to your default text editor — in my case, micro.

The notes themselves are in a straightforward Markdown. See Joplin's Markdown guide for those details.

Keep in mind that this is just a Markdown file to your editor. Any impressive integration with Joplin requires work in the editor config. I have not done anything with that yet. I use Joplin's desktop app for anything fancier than jotting down quick notes.

Edit. Save. Quit the editor. You're back in Joplin, and your updated content is in Joplin's content pane.

Deleting a note

I forgot about the quotes and made myself a "Terminal" note. How do I delete it?

:rmnote Terminal

Joplin asks for confirmation, defaulting to "No" because you can't get the note back once deleted.

Organizing notes into notebooks

I can see this becoming a whole series of notes.

:mkbook MyJoplinNotes

Didn't feel like using quotes this time. Anyways, "MyJoplinNotes" gets created at the top level. Joplin automatically sets it as the notebook I'm using.

"Using" a particular notebook means this is where your focus is. Any new notes you create end up in the notebook you're using.

I need to get this note over to the right location. First I use the random notebook I started in.

:use 'Nerd notes'

my first round notebook names tend to be terrible. Sorry.

Moving notes

Now I can move it, letting Joplin help me with autocompletion.

:mv 'Terminal notes with Joplin' MyJoplinNotes

Switch over to the new notebook:

:use MyJoplinNotes

And there it is.

: ls
Terminal notes with Joplin

Renaming notes

Of course, now that it's in a dedicated notebook the name seems redundant. Let's rename this note.

:ren 'Terminal notes with Joplin' 'Adding and Organizing Notes'

Parting thought

Even though Joplin keeps a narrow focus, there's much more than I looked at here. I just wanted to take some notes. You can manage tasks with it, and even extend it with an API.

Keep your notes short, unless your editor supports folding. If it does? Go wild. Have fun!

Mastodon Twitter

Other Links

Liberapay is patronage for the FOSS and CC community.

Become a patron!