/pocket-reader.el

Emacs client for Pocket reading list (getpocket.com)
  1. Emacs Lisp 100.0%
Emacs Lisp
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP
Find file
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
screenshots
LICENSE
README.org
dont-tread-on-emacs-150.png
pocket-reader.el

README.org

pocket-reader

https://melpa.org/packages/pocket-reader-badge.svg https://stable.melpa.org/packages/pocket-reader-badge.svg

This is a client for Pocket (getpocket.com). It allows you to manage your reading list: add, remove, delete, tag, view, favorite, etc. Doing so in Emacs with the keyboard is fast and efficient. Links can be opened in Emacs with any function, or in external browsers, and specific sites/URLs can be opened with specific browser functions. Views can be sorted by date, title, domain, tags, favorite, etc, and “limited” mutt-style. Items can be searched for using keywords, tags, favorite status, unread/archived status, etc. Items can optionally be colorized by site, making it easy to tell which items come from different sites. Items are grouped depending on the sort column.

Contents

Screenshots

Marked items are displayed with inverse colors.

Sorted by date-added, with both title and site colorized:

screenshots/by-date-colorized.png

Sorted by site, with only the site colorized:

screenshots/by-site-only-site-colorized.png

Sorted by favorite status, not colorized:

screenshots/by-favorite-not-colorized.png

Sorted by date, showing some excerpts, some marked items, and the bottom window displaying one of the articles using the org-web-tools-read-url-as-org command (currently the default when RET is pressed):

screenshots/with-excerpts-and-org-web-tools.png

Installation

MELPA

If you installed from MELPA, just run the pocket-reader command.

Manual

Install the required packages listed in pocket-reader.el. Then put this in your init file and run the pocket-reader command:

(require 'pocket-reader)

Usage

In eww, Org, w3m, and some other major modes, the pocket-reader-add-link command can be used to add a link at point to Pocket.

Keys

Commands operate on the current item or marked items. These keys can be used in the pocket-reader buffer:

  • RET: Open with default browse function.
  • TAB: Open with default pop-to function.
  • b: Open with external browser function.
  • a: Toggle archived/unread status.
  • c: Copy URL to the kill ring.
  • D: Delete item.
  • e: Show excerpt.
  • E: Show excerpt for all items.
  • *, f: Toggle favorite status.
  • F: Show unread, favorite items.
  • g: Refresh list using last query (or default query).
  • s: Search for items (or display default view if no query is entered).
  • m: Toggle mark of current item.
  • M: Mark all items.
  • U: Unmark all items.
  • o: Show more items (using the current count limit).
  • l: Limit current view to items matching string (this does not run a new search).
  • r: Open random item from current items. With prefix, read a key and call command bound to it instead of using the default opening function (e.g. use b to open in external browser).
  • ta: Add tags.
  • tr: Remove tags.
  • tt: Set tags.
  • ts: Search for a tag.

Searching

These special keywords can be used when searching:

  • :*, :favorite Return only favorited items.
  • :archive Return only archived items.
  • :unread Return only unread items (default).
  • :all Return all items.
  • :COUNT Return at most COUNT (a number) items. This limit persists until a new search is run.
  • :t:TAG, t:TAG Return items with TAG (only one tag may be searched for, a limitation of the Pocket API).

Changelog

0.1.1

Fix: Use “given” URL if no AMP or “resolved” URL is available.

0.1

Initial release.

Development

Bug reports, feature requests, suggestions — oh my!

License

GPLv3