#ssg #pocket #save-it-later #reading-list

app research

Manage your reading lists and generate a static site with your saved articles

8 releases

new 0.1.7 Feb 18, 2024
0.1.6 Feb 13, 2024

#1 in #static-site-generator

Download history 1/week @ 2023-11-01 2/week @ 2023-11-08 1/week @ 2023-11-22 3/week @ 2023-11-29 174/week @ 2024-02-07 422/week @ 2024-02-14

596 downloads per month

Apache-2.0

580KB
911 lines

Research Pocket 🔖

The last save-it-later tool you'll ever need


A self-hostable save-it-later tool that integrates with getpocket.com (and others soon). works on the web and terminal

How it works

Hashnode logo

Installation

  • Get the latest release binary for your desktop through the releases page

  • Using Cargo

    $ cargo install research
    

Generate your site

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

Cli help

  • 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

    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

    Generate a static site
    
    Usage: research generate [OPTIONS] <PATH>
    
    Arguments:
      <PATH>  The path to the output directory
    
    Options:
          --assets <ASSETS_DIR>  Path to site assets (main.css, search.js) RELATIVE to the output directory [default: ./assets]
          --download-tailwind    Download Tailwind binary to <ASSETS_DIR>/tailwindcss if not found
      -h, --help                 Print help
    

Dependencies

~37–53MB
~1M SLoC