Skip to content

skeletonkey/joplin_alfred_workflow

Repository files navigation

Joplin Alfred Workflow

Alfred Workflow to interact with the Joplin API.

Requirements

  • Curl
  • Perl 5
    • JSON module

Installation

Workflow Installation

Find the latest release on the right-hand side of the main README page (right side). Download the '.alfredworkflow' file for the release you wish to install. Next, open the file on your desktop - this should open/install the workflow in Alfred.

Workflow Configuration

In Alfred, select the Joplin Workflow and open the Configuration Build (top right, it looks like '(x)'). Configuration Build

On the Environment Variables tab, provide your token for JOPLIN_TOKEN and ensure that JOPLIN_URL has the correct Port. Env Vars

Joplin Web Clipper

To use Joplin's API, the Web Clipper needs to be enabled.

Web Clipper can be enabled by going to Joplin Preferences (Options) -> Web Clipper and enabling the web clipper. Joplin Clipper

Note the Port that it is running on and copy your Authorization Token.

Curl

brew install curl

Brew Install Insturctions

Perl

Perl should already be installed on your Mac device.

brew install perl

Brew Install Insturctions

JSON Module

cpan install JSON

Usage

Search

jn folder

Create a new note and open it in the specified folder.

Only an empty note (no title, no body) is created. Issue #9 has been created to address this shortcoming.

js search words

Search all of Joplin for the string entered.

NOTE: Joplin search operates on 'Words'; therefore, partial strings may not return what you expect.

BUG currently, words separated with a space are treated as two tokens with an AND operation instead of one string.

jt search words

Search Joplin Note Titles for the string entered.

NOTE: Joplin search operates on 'Words'; therefore, partial strings may not return what you expect.