https://github.com/mheap/pocket-tagger-cli
https://github.com/mheap/pocket-tagger-cli
cli
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mheap/pocket-tagger-cli
- Owner: mheap
- Created: 2018-07-10T22:09:10.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2025-01-02T06:24:56.000Z (over 1 year ago)
- Last Synced: 2025-02-24T14:13:52.902Z (over 1 year ago)
- Topics: cli
- Language: JavaScript
- Homepage:
- Size: 620 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# pocket-tagger-cli
This is a CLI for [pocket-tagger](https://github.com/mheap/pocket-tagger), a
library that allows you to tag your pocket articles using user defined rules.
For an example rule configuration file, see [tagger.json](example/tagger.json).
## Installation
Install `pocket-tagger-cli` using `npm`:
```bash
npm install -g pocket-tagger-cli
```
### Authenticating with Pocket
This tool reads your credentials from `~/.pocket/credentials`. You must create
a file at this location with the following format:
```
[default]
access_token=abc-def-ghi-jkl-mno
consumer_key=123-afie0r3h9r30320fr
```
If you need to generate an access token and consumer key,
[pocket-auth-cli](https://github.com/mheap/pocket-auth-cli) may be useful.
## Running the tool
You can run `pocket-tagger --help` at any time to see the available options.
If this is the first time you're running the tool you'll need to generate an
example tagger config using the following command:
```bash
pocket-tagger --generate ~/.pocket/tagger.json
```
Once you have a config, you can run the tool by running `pocket-tagger` without
any arguments. The default config contains tags for article length, a few
programming languages and sites such as youtube. It also caches the contents of
each site in `/tmp` for 1 day. This allows you to edit your tagging rules without
needing to download the contents of every site each time.