Project

joplin

0.0
The project is in a healthy, maintained state
joplin API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 13.0
~> 3.12.0
~> 2.0

Runtime

~> 5.1.1
~> 1.6.3
~> 1.2.2
 Project Readme

Joplin

usage

Creating a note

Joplin::token = "your joplintoken here copied from the webclippper settings"

begin
  note = Joplin::Note.new
  note.title = "a new note"
  note.body = "markdown content"
  note.save!
rescue
  puts "Joplin not running?"
end

updating a note

  note = Joplin::Note.new id: "6e3811c7a73148a" # note id can be found in the information of any note
  note.title = "a new note title"
  note.save!

A note on the token

If you've got joplin installed, you can do:

require "joplin/token"
token = Joplin::Token.get

to get the token programatically. It reads from the sqlite database located in ~/.config/joplin-desktop

Saving to a specific notebook

You can specify the id of the notebook

  note = Joplin::Note.new parent_id: 'c5e6827be8c946c78210d3508cce7ea6'

CLI

joplin nb2n --token 'notebook name'

Will take a notebook and concatenate all notes into one for easy export to PDF

The token argument is optional and if you have it installed locally it will find the token

joplin epub

This will generate an epub from the referenced notes in the note. It will not include the actual note, but only linked markdown notes within. Rendering things like tables, mermaid diagrams etc is not supported