2 releases
0.1.1 | Jul 10, 2022 |
---|---|
0.1.0 | Apr 30, 2019 |
#11 in #article
22KB
474 lines
Pickpocket
Pickpocket is a command line tool which will help you with your Pocket library. It selects a random article for you to read, opening your browser and marking it is deleted.
Installation
Pickpocket is distributed as a Rust crate, also having its Linux, MacOS and Windows binaries released on this repository.
Binaries
Binaries for all OSes are available at the "releases page"
cargo
If you wish to run this CLI using Rust's cargo
:
- Run
cargo install pickpocket
- Execute the binary through
cargo
's default install path. Example:~/.cargo/bin/pickpocket status
Authentication
To use Pickpocket, you first need to go through Pocket's OAuth authentication process.
- Execute the
pickpocket oauth
command- This will open your web browser, asking you to approve Pickpocket's OAuth token
- Execute the
pickpocket authorize
command- This will authorize your OAuth token against Pocket, creating an authorization token
Usage
pickpocket pick
- Selects a random article from your list, and open your browser with its resolved URL
- Options:
-q
: quantity of articles to open. Examples:pickpocket pick -q 10
(open 10 articles)
pickpocket renew
- This will synchronize your local library with your remote. Keep in mind: any article marked as read WILL BE DELETED from your remote library
pickpocket status
- Show the number of read/unread articles you have on your local library
Pickpocket Files
All Pickpocket files are stored at the ~/.pickpocket
folder.
library_file
- YAML file which stores your local library, marking articles as unread or read
authorization_token
- File which stores your authorization token
oauth_token
- File which stores your OAuth token
Don't Trust Me?
Pickpocket ships with its own consumer key, which will ask for access to modify/retrieve your articles.
If you don't like this idea, you can use your own consumer key, setting up the POCKET_CONSUMER_KEY
environment variable before calling it.
Example:
POCKET_CONSUMER_KEY="my-consumer-key" pickpocket oauth
To know more about consumer keys and how Pocket deals with third party applications, read more on Pocket's Authentication API documentation.
License
MIT
Dependencies
~21MB
~444K SLoC