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.
Marked items are displayed with inverse colors.
Sorted by date-added, with both title and site colorized:
Sorted by site, with only the site colorized:
Sorted by favorite status, not colorized:
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):
A screenshot with the default Emacs theme and default settings:
If you installed from MELPA, just run the pocket-reader command.
Note: Please ignore any Page Not Found error you might see on the Pocket Web site after authorizing. Just run the pocket-reader command after authorizing, and it should work. You can verify that authorization completed by checking the file ~/.cache/emacs-pocket-lib-token.json.
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)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.
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: Show default view.D: Delete item.e: Show excerpt.E: Show excerpt for all items.*,f: Toggle favorite status.F: Show unread, favorite items.g: Re-sort list.G: Refresh list using last query (or default query).s: Search for items (or display default view if no query is entered). With prefix, add items instead of replacing (this can be used in lieu of boolean OR searches, since Pocket doesn’t support them).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. usebto open in external browser).ta: Add tags.tr: Remove tags.tt: Set tags.ts: Search for a tag.
These special keywords can be used when searching:
:*,:favoriteReturn only favorited items.:archiveReturn only archived items.:unreadReturn only unread items (default).:allReturn all items.:COUNTReturn at most COUNT (a number) items. This limit persists until a new search is run.:t:TAG,t:TAGReturn items with TAG (only one tag may be searched for, a limitation of the Pocket API).
- Handle null or blank URLs returned by Pocket. (Fixes #19, #20. Thanks to Aaron Zeng.)
- Handle links in Org buffers that span lines. (Thanks to Aaron Zeng.)
pocket-reader-search(bound tos) can be called with a prefix to add items to the list instead of replacing the list, which can be used in lieu of boolean OR searches, since Pocket doesn’t support them. For example, you could define a custom search command like:
(defun ap/pocket-reader-show-favorites ()
"Show favorites and items tagged \"check\"."
(interactive)
(pocket-reader-search ":* :unread")
(pocket-reader-search ":all t:check" :add t))pocket-reader-moreandpocket-reader-refreshboth handle multiple queries whenpocket-reader-searchis called with a prefix. For example, you could search fort:emacs, then add results fort:linux, and thenpocket-reader-morewould add more items for both queries, andpocket-reader-refreshwould update the list for both queries. Or, in other words, these commands “DTRT.”- A custom sorting function can be set for the
Addedcolumn using the optionpocket-reader-added-column-sort-function.- The default now sorts by date, then by favorite status, then by tags, and finally by domain.
- The queries used for the default, initial view are now stored in the option
pocket-reader-default-queries, and pressingdshows the default view. pocket-reader-add-linknow supports Elfeed, w3m, andshr-modebuffers.pocket-reader-domain-url-type-mapmaps domains to “types” of URLs to prefer. This is useful for, e.g. avoiding AMP URLs, which Pocket provides in their API (or for preferring them, on sites where the AMP version is more readable). This variable may be customized.
- Default bind for
pocket-reader-unmark-allchanged fromUtou. There was nothing bound tou, and pressing Shift was tiresome. - Bind re-sort command to
g, and refresh command toG. This is similar toelfeed. - Bind
random-itemcommand toRinstead ofr. Sinceris often a “mark as read” command, this will help avoid accidentally opening random items. - Use hash-tables internally instead of text-properties.
- Unmark all items before limiting display, to prevent marked, hidden items from being modified.
- Link-adding functions are now autoloaded, so they can be used even if
pocket-readerhasn’t been run yet. - Require
subr-xforif-let. - Use
cl-incfinstead ofincf. - Allow searching for tags with hyphens and other “non-word” characters.
Fix: Use “given” URL if no AMP or “resolved” URL is available.
Initial release.
Bug reports, feature requests, suggestions — oh my!
GPLv3