Crates.io | research |
lib.rs | research |
version | 0.1.12 |
source | src |
created_at | 2024-02-11 14:36:41.862344 |
updated_at | 2024-05-14 23:59:35.521007 |
description | Manage your reading lists and generate a static site with your saved articles. |
homepage | |
repository | https://github.com/KorigamiK/ResearchPocket |
max_upload_size | |
id | 1135868 |
size | 722,398 |
A self-hostable save-it-later tool that integrates with getpocket.com (and others soon). works on the web and terminal
Create your own static site on GitHub pages ResearchPocket/my-list 📚
Get the latest release binary for your desktop through the releases page
Using Cargo
$ cargo install research
This requires that you have
tailwindcss installed and
available in your $PATH
$ 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
Basic Help
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 <DB_URL> Database url [env: DATABASE_URL=] [default: ./research.sqlite]
-d, --debug... Turn debugging information on
-h, --help Print help
-V, --version Print version
Init
Initializes the database
Usage: research init <PATH>
Arguments:
<PATH>
Options:
-h, --help Print help
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
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:
$ research --db <path/to/research.sqlite> generate --assets <path/to/assets> <path/to/output>
Optionally add --download-tailwind
to download and reuse the tailwindcss
binary in the assets directory.
Generate a static site
Usage: research generate [OPTIONS] <OUTPUT>
Arguments:
<OUTPUT> The path to the output directory
Options:
--assets <ASSETS> Path to required site assets (main.css, search.js, tailwind.config.js) [default: ./assets]
--download-tailwind Download Tailwind binary to <ASSETS>/tailwindcss if not found
-h, --help Print help