mrtazz/pocketcleaner

# pocketcleaner

[![Build Status](https://travis-ci.org/mrtazz/pocketcleaner.svg?branch=master)](https://travis-ci.org/mrtazz/pocketcleaner)
[![Coverage Status](https://coveralls.io/repos/mrtazz/pocketcleaner/badge.svg?branch=master&service=github)](https://coveralls.io/github/mrtazz/pocketcleaner?branch=master)
[![Code Climate](https://codeclimate.com/github/mrtazz/pocketcleaner/badges/gpa.svg)](https://codeclimate.com/github/mrtazz/pocketcleaner)
[![Packagecloud](https://img.shields.io/badge/packagecloud-available-brightgreen.svg)](https://packagecloud.io/mrtazz/pocketcleaner)
[![GoDoc](https://godoc.org/github.com/mrtazz/pocketcleaner?status.svg)](https://godoc.org/github.com/mrtazz/pocketcleaner)
[![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](http://opensource.org/licenses/MIT)

## Overview

This is a utility to keep your [Pocket](https://getpocket.com) list small and
manageable. It will archive all items in your list except for the newest `n`
items.

**WARNING**: This will *archive* items. Something you can't just undo.

## Usage
```
pocketcleaner keeps your pocket clean

Usage:
  pocketcleaner [-d | --debug] [--keep=<keepCount>]
  pocketcleaner -h | --help | -v | --version

Options:
  -h --help          Show this screen.
  -d --debug         Show debug information.
  -v --version       Show version.
  --config=<config>  Config file to use
  --keep=<keepCount> Count of items to keep
```

## Installation

### Get auth tokens to use with pocketcleaner

Pocketcleaner doesn't come with any auth keys, so you will have to get your
own. The following steps are taken from
[here](http://www.jamesfmackenzie.com/getting-started-with-the-pocket-developer-api/).

#### 1. Create an app in the [developer portal](http://getpocket.com/developer/)

Make sure it has at least the `retrieve` and `modify` permissions.

#### 2. Get a request token

```
curl https://getpocket.com/v3/oauth/request -X POST \
-H "Content-Type: application/json" -H "X-Accept: application/json" \
-d '{"consumer_key":"your-key-here","redirect_uri":"http://www.google.com"}'
```

#### 3. Authorize the app

Visit the following URL in your browser and authorize the app.

```
https://getpocket.com/auth/authorize?request_token=request-token-here&redirect_uri=http://www.google.com
```

#### 4. Convert request token to access token

```
curl https://getpocket.com/v3/oauth/authorize -X POST \
-H "Content-Type: application/json" -H "X-Accept: application/json" \
-d '{"consumer_key":"your-key-here","code":"request-token"}'
```

#### 5. Make sure the token works by getting a list of your saved items

```
curl http://getpocket.com/v3/get -X POST -H "Content-Type: application/json" \
-H "X-Accept: application/json" \
-d '{"consumer_key":"your-key-here", "access_token":"access-token"}'
```

### Install pocketcleaner

There are packages for linux up [on
packagecloud.io](https://packagecloud.io/mrtazz/pocketcleaner) but you can also just clone the repo and build the binary yourself.

```
go get github.com/mrtazz/pocketcleaner
cd $GOPATH/src/github.com/mrtazz/pocketcleaner
make
```

### Docker
There is also a docker image on docker hub which you can use to run
pocketcleaner like this:

```
docker pull mrtazz/pocketcleaner
docker run -i -e "POCKETCLEANER_CONSUMER_SECRET=your_secret" -e "POCKETCLEANER_ACCESS_TOKEN=your_token" --rm mrtazz/pocketcleaner
```

## Configuration
pocketcleaner reads the configuration file `$HOME/.pocketcleaner.ini` to get
consumer key, access token, and the number of items to keep. The format looks
like this:

```
consumer_key      = consumer-key
access_token      = access-token
keep_count        = 100
```