alfred-goodreads

command module
v0.1.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 10, 2020 License: MIT Imports: 29 Imported by: 0

README

Goodreads Book Search for Alfred 4

Search for movies, TV shows and people in Alfred 4.

Download & installation

Grab the workflow from the releases page. Download the Goodreads-Search-X.X.X.alfredworkflow file and double-click it to install.

Usage

  • gr <query> — Search for a book.
    • — Open book details in browser.
    • ⌘↩ — Open author page in browser.
    • ... — Open custom URL (see configuration).

Configuration

There are a couple of options in the workflow's configuration sheet (the [x] button in Alfred Preferences):

Setting Description
API_KEY Goodreads.com API key
MAX_CACHE_AGE How long to cache search results for
Custom URLs

You can assign custom URLs to arbitrary modifier keys by setting URL_MOD[_MOD...] variables. So URL_OPT sets a URL to open with you press ⌥↩ on a result, and URL_OPT_SHIFT sets a URL to open when you press ⌥⇧↩ on a result.

You can use shell-like variable expansion in URLs to insert book or author information in to the URL, e.g. https://duckduckgo.com/?q=${Title}.

The following variables are available:

Variable Meaning
Title Book title
Author Author name
AuthorID Author ID (for Goodreads)
AuthorURL Author page on Goodreads.com
AuthorTitle Author name & book title
Year Year of first publication
Rating Average rating (0.0 – 5.0)
URL Book page on Goodreads.com
ImageURL URL of cover image

Values are URL query-escaped by default (i.e. spaces are replaced with +). If you need path-escaped values (i.e. spaces are replaced with %20), use the *Alt variants (TitleAlt, AuthorAlt etc.). The original, unescaped values are available via the *Raw variables (TitleRaw, AuthorRaw etc.).

Licensing & thanks

This workflow is released under the MIT Licence.

It is based on AwGo (MIT).

The icons are from or based on Font Awesome (SIL).

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL