My Digital Garden

Use steampipe to query hypothes.is

Use steampipe to query hypothes.is

Using the Hypothesis plugin Steampipe can run sql-like queries over your personal annotations and any public annotations.

Installing

  1. install / update steampipe

    (on Windows this needs to be in a WSL2 environment)

    cd ~
sudo /bin/sh -c "$(curl -fsSL https://steampipe.io/install/steampipe.sh)"

  2. Install the Hypothesis plugin

    steampipe plugin install hypothesis

  3. Find your Hypothes.is developer key

    • log in to hypothes.is
    • visit https://hypothes.is/account/developer

  4. Add your Hypothes.is developer key to the Steampipe config

    vi .steampipe/config/hypothesis.spc
 # uncomment #token and provide your API token
 # save the file

Operation

To get started with exploring what can be done:

  1. create a working directory
  2. copy the example dashboard files from here

Run the sample dashboard

steampipe dashboard

Note I had to edit the sample dashboard files to make this work

Running custom queries

The details of the steampipe table for Hypothes.is are here.

To run custom queries either type them at the interactive query prompt obtained by entering steampipe query, or save them in a plain text file, e.g. testquery.sql, which you can then run like this:

steampipe query testquery.sql --output csv -- > output.csv

See also Sample Steampipe queries for Hypothesis

See also