NAME

pocket - interact with the Pocket API from the command line

VERSION

version 0.03

SYNOPSIS

pocket [command] [options ...]

Commands:

 help               Displays this synopsis.
 man                Displays full documentation.
 list               Print all unread URLs in your account.
 search <string>    Print all URLs whose title or URL contains C<string>.
 favorites          Print all unread, favorite URLs.
 add <url [title]>  Add URL, optionally with title.
 archive <url>      Archive URL.
 readd <url>        Unread/unarchive URL.
 favorite <url>     Favorite URL.
 delete <url>       Delete URL.
 words              Print the number of words in all unread articles.
 authenticate       Authenticate and store credentials in C<~/.pocket>.
                    (all commands will do this automatically)

Example usage:

  $ pocket list
  Enter your consumer key: ...
  Visit https://getpocket.com/auth/authorize?request_token=...&redirect_uri=https://getpocket.com/ and log in. When you're done, press enter to continue.

  http://the-toast.net/2015/04/27/looking-back-fragments-from-womens-shelters-1981-1996/view-all/
  https://modelviewculture.com/pieces/dreaming-holding-onto-the-hope-of-justice-in-technology-and-america
  [...]

  $ pocket words --archive
  2233913

DESCRIPTION

This program provides several subcommands to allow you to interact with your Pocket list from the command line. It will automatically authenticate as needed, prompting you for your consumer key, and will store the returned credentials in ~/.pocket.

NAME

pocket - A command-line tool for Pocket (http://www.getpocket.com/)

COMMANDS

authenticate

Authenticates you with the Pocket API and does nothing else. Not usually necessary, since all of the following commands will automatically authenticate as necessary.

list

Prints the URLs in your list. By default, prints unread URLs, but also takes options to adjust the list that is returned:

--unread

Return only unread links. This is the default, but can be provided for explicitness.

--archive

Return only archived links.

--all

Return both unread and archived links.

--tag=<tag>

Return links with the given tag. This option can be passed multiple times, and may be combined with the above options.

words

Takes the same options as list, but instead of printing the URLs of the articles, prints the number of words in all of those articles combined.

search <string>

Returns a list of URLs whose title or URL contains string. Takes the same options as list to limit the search.

favorites

Returns a list of favorited URLs. Takes the same options as list.

add <url> [title]

Adds url to your list, optionally with the given title.

archive <url>

Moves url from your list to your archive.

readd <url>

Moves url from your archive to your list.

favorite <url>

Marks url as a favorite.

unfavorite <url>

Unmarks url as a favorite.

delete <url>

Deletes url from your list and/or archive entirely.

AUTHOR

Jesse Luehrs <doy@tozt.net>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2016 by Jesse Luehrs.

This is free software, licensed under:

  The MIT (X11) License