pinboard rs

Alfred Workflow for Pinboard (Rust)

From this project's GitHub repository:

Build Status Build status

Alfred Workflow for Pinboard

Manage, post and preview your bookmarks on Pinboard right from within Alfred app.

Important: Update & Support for Alfred 3 Users

Alfred 4: If upgrading workflow from 0.14.14 or before, you may have to directly download latest version and then open it in Finder

Features

Pinboard is a great and reliable bookmarking service. Its front page sums it all:
Social Bookmarking for Introverts. Pinboard is a fast, no-nonsense bookmarking site.

This plugin will let you:

  • post a bookmark to Pinboard right from Alfred, with:
    • Fetching bookmark information from active browser’s window
    • tag auto-completion to show your current tags.
    • popular tags for the current url
    • and more …
  • search your current bookmarks
    • Tap Shift to show a preview of selected item without opening browser.
    • Tap Command+L to show Large toast of title
    • Tap Command to show current item’s tags
    • Tap Control to show current item’s extended notes/descriptioin.
  • Automatic updates of workflow
  • Many options that can be easily adjusted. (see below)

TLDR;

After initial setup:

  • For posting you just need to enter the Workflow’s keyword ( p ) into Alfred’s window and follow it with couple of tags and an optional description. The workflow will then post a bookmark for the window/tab of the active browser to Pinboard.

  • For searching, use ( ps ) and then type the search keywords.

Supported Browsers:

  • Safari
  • Chromium
  • Firefox (See known issues )
  • Opera
  • Vivaldi
  • Brave
  • Firefox Dev. Edition
  • Safari Tech. Preview
  • Chrome

Installation / Setup

After downloading the latest version of the workflow and installing it in Alfred, you need to do a one-time setup to authenticate the Workflow. This Workflow only uses username/token method so you won’t need to enter your password. (This is the suggested way of using Pinboard’s API).
If you don’t have a token, get one from Pinbaord’s setting’s page.

Then invoke Alfred and enter your username:token after the “pa” keyword:

image

This workflow will keep a local cache of the tags and bookmarks that you have in Pinboard, and, by default, automatically update the cache. (See manual updates )


Usage (post a bookmark):

The syntax to post a bookmark to Pinboard is :

p tag1 tag2 tag3 ; some optional note (semi-colon & note are optional)

The workflow will show a list of your current tags as you are typing:

image

The number below each tag shows how many times you have used it in Pinboard bookmarks.
You can move Alfred’s highlighter to the desired tag and hit ‘Tab‘ to autocomplete it.

To finish the process just press Enter.

  • If tag suggestion feature is enabled (see pset suggest_tags), 3 popular tags based on current active webpage will be added to the list of your tags. The list is fetched from Pinboard’s API and is often helpful. However this feature will add a 1 second delay to showing the tag list after first keystroke. This delay is disabled for consequent keystrokes as the fetched popular tags are cached.

    image

Modifiers (Control ⌃, Option ⌥)

You can hold down modifiers to one-time change some of your settings:

  • Control ⌃ : will mark the bookmark as toread (regardless of settings)
  • Option ⌥ : will mark the bookmark as shared (regardless of settings)

After entering last desired tag, you can hit enter to post the bookmark.
If you want to add extra description to the bookmark you can add it after a semi-colon:

image

Already saved bookmark

If the current page is already saved, you will be notified. However the workflow assumes that:

  • http://example.com/list.html
  • https://example.com/list.html
  • http://example.com/list.html#fragment

are all different bookmarks and will not notify you about duplication!

image


Usage (search bookmarks):

Searching your bookmarks is easy.

ps query1 query2 query3 ...

Workflow will use the text you enter in Alfred and show list of bookmarks that contain all of the search keywords in any of the bookmarks information (Desrciption of bookmark, its tags, its url and its extended notes). However, these search fields can be adjusted, see settings.

So the more search keywords you enter the less results will be displayed as it tries to find the bookmarks that contain all of the keywords.

The search result is ordered in descending order of dates they were posted to your Pinboard account.

image

To show tags (instead of URLS) in search results subtitles, use pset url_tag:

image

Modifier keys (Command ⌘, Control ⌃, Option ⌥)

You can hold down modifiers to enable different behavior:

  • Control ⌃ : will show the extended description of selected bookmark.
  • Command ⌘ : will show tags of selected bookmark.
  • Option ⌥ : Holding and pressing enter will open the bookmark in Pinboard’s website.
  • Command ⌘ + Option ⌥ : Hitting Return ⏎ key with these combo modifiers will copy the bookmark’s URL to clipboard.
  • Shift ⇧: Tap ⇧ to load a preview of bookmark without opening your browser 😎 ⤵︎

image


Usage (delete a bookmark):

pind

To delete a bookmark, just make sure it is opened in your current browser’s window. Then use pind.
Proposed workflow for deleting a bookmark is to first open it in browser (search for it using this workflow’s keyword ps, and hit enter) and then use pind keyword followed by enter.

image

Settings

You can configure the behavior of workflow by entering pconf in Alfred:

image

Selecting each setting and hitting ⏎ (Enter) will let you adjust it:

image

On top of using pconf, you can directly type following commands to also adjust the settings:

  • pset fuzzy: Enable/disable fuzzy search.
  • pset suggest_tags: When posting a new bookmark, list popular tags for the active page. Note that this information is fetched from Pinboard and sometimes is not very accurate.
  • pset shared: Mark all new bookmarks as shared.
  • pset toread: Mark all new bookmarks as toread.
  • pset check_bookmarked: Notify if active page is already bookmarked.
  • pset tagonly: Only search within tag field while doing any look-up.
  • pset auto: After posting a new bookmark, automatically update the local cache.
  • pset tags: Set number of tags to show: pset tags 25
  • pset bookmarks: Set number of bookmarks to show: pset bookmarks 12
  • pset url_tag: Show either URLs or tags in search results subtitles

Manual cache update

To manually update the cache, you need to issue the pu command:

image


Most of configuration settings are self-explanatory. However fuzzy search may need a demo.

When fuzzy search is enabled, the tags/bookmarks that contain the query letters in the given order are displayed:

image

Otherwise, normal search will search for consecutive characters in query:

image


Misc.

  • Workflow will check for newever version of itself every 24 hours. This check only takes place when you actually use one of its keywords (no background service is ever used). You can also manually check for updates using pcheck.

image

  • This workflow tries to show some helpful errors in different cases.

image
image
image

  • If you want to change some behavior take a look at Alfred’s workflow page:

image


Known Issues

  • Firefox: While tag suggestions and “Check if page is bookmarked” options are enabled, posting bookmark from Firefox is broken. Deleting bookmarks using pind won’t work when Firefox is your active browser. Reason: Firefox does not properly support interacting with it programatically.
  • This workflow is setup to work with Aflred 4. It may or may not work with previous version as it has not been tested for them.

Alfred 3 Support & Issues

  • Alfred 4 has made some changes to internal structure of workflows. Therefore if you updated this workflow through the built-in automatic update, it’s very likely that it’ll stop working. If that happens, you can fix it by first deleteing & then re-installing the workflow by downloading the last version (0.14.11) that has Alfred 3 format.
  • Moving forward, new features, changes & bug fixes will first target Alfred 4 users and then (time permitting) will be ported back to Alfred 3.

TODO

I wish to add the following in the coming releases:

  • Let users delete a selected bookmark from witin Alfred.
  • Add a proper logging facility to Rust code. (uses log_env)
  • Use a better error mechanism (maybe failure?)

Feedback / Bugs

This is my first non-trivial project using Rust language so so your feedback or bug reports are greatly appreciated.

License

This open source software is licensed under MIT License.