A self-hostable save-it-later tool that integrates with
[getpocket.com](https://getpocket.com) (and others soon). works on the web and
terminal
> Create your own static site on GitHub pages
[ResearchPocket/my-list](https://github.com/ResearchPocket/my-list) 📚
## How it works
## Installation
- Get the latest release binary for your desktop through the
[releases page](https://github.com/KorigamiK/ResearchPocket/releases)
- Using Cargo
```sh
$ cargo install research
```
## Generate your site
This requires that you have
[tailwindcss](https://tailwindcss.com/blog/standalone-cli) installed and
available in your `$PATH`
```sh
$ research init # initializes the database
$ research pocket auth # authenticate with pocket
$ research fetch # fetches your articles
$ # add --download-tailwind if you don't have tailwindcss installed in your $PATH
$ research --db ./research.sqlite generate . # generate your site
```
## Cli help
- Basic Help
```sh
RESEARCH 🔖
Manage your reading lists and generate a static site with your saved articles.
Usage: research [OPTIONS] [COMMAND]
Commands:
pocket Pocket related actions
fetch Gets all data from authenticated providers
list Lists all items in the database
init Initializes the database
generate Generate a static site
help Print this message or the help of the given subcommand(s)
Options:
--db Database url [env: DATABASE_URL=] [default: ./research.sqlite]
-d, --debug... Turn debugging information on
-h, --help Print help
-V, --version Print version
```
- Init
```sh
Initializes the database
Usage: research init
Arguments:
Options:
-h, --help Print help
```
- Pocket
```sh
Pocket related actions
Usage: research pocket [COMMAND]
Commands:
auth Authenticate using a consumer key
fetch Fetch items from pocket
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
```
- Fetch
```sh
Gets all data from authenticated providers
Usage: research fetch
Options:
-h, --help Print help
```
- Generate
Here's an example of how to generate a static site:
```sh
$ research --db generate --assets
```
Optionally add `--download-tailwind` to download and reuse the `tailwindcss`
binary in the assets directory.
```sh
Generate a static site
Usage: research generate [OPTIONS]
