Giter VIP home page Giter VIP logo

joplin_alfred_workflow's Introduction

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.

joplin_alfred_workflow's People

Contributors

skeletonkey avatar

Watchers

 avatar

joplin_alfred_workflow's Issues

Searching for special characters doesn't work

Searching for a special character does not return any data.
The encoding is working (when removing it and simply sending the character yields literally no data instead of an empty result set), but it's not returning any notes.
This appears to be an issue with Joplin's API and needs to be researched.

jn - allow for creating a note title

Summary
When using 'jn' I want to be able to provide a note title after folder the note goes in.

Acceptance Criteria

  • be able to specify 'title' when creating a new note

Caching

Summary
Need some type of caching to make the workflow snappier

Acceptance Criteria

  • either Alfred Cache or PP cache
    • no 3rd party code should be required to install
  • keys needs to have individual expiration times
  • mechanism to clear the cache
    • full clear
    • clear individual keys

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.