ssb-plugin that indexes all the links!


if you have a handle on the sbot server:

sbot.use(require('ssb-links'){query: [{$filter: {rel: ['mentions', {$prefix: '@d'}]}}]})

OR if sbot is a client...

links2 = require('ssb-links').init(sbot, {path: '~/.ssb'}){query: [{$filter: {rel: ['mentions', {$prefix: '@d'}]}}]})


Most clients will install ssb-links for you, but if you're running ssb-server standalone you may see a message like:

WARNING-DEPRECATION: ssb-links not installed as a plugin. If you are using git-ssb, ssb-npm or patchfoo please consider installing it

If you are using one of the listed clients then run this command to install it: ssb-server plugins.install ssb-links then add {"plugins":{"ssb-links": "links2"}} to your .ssb/config. If you later switch to a client that enables this plugin automatically just remove the line from your .ssb/config.


a leveldb instance will be created at config.path+'/links'

api: ({query: QUERY, live, reverse, limit})

If there is no query provided, a full scan of the links database will be performed. this will return a stream of data that looks like

  source: @{author_of_link},
  rel: [{rel}, {rel_data}...],
  dest: @/%/&{link} //the dest can be any type of ssb object.
  ts: {local_timestamp}

this format will be the input to the query.

relation data.

this module introduces the concept of "rel data", the rel is now stored as an array, and the data associated with the rel stored with it. by indexing it as an array, it becomes easy to query it when that data is a sortable range (for example, mention names, which may be aphabetically sorted)

see ./links.js to see how data is mapped.

TODO: map all markdown links, including http links.

query syntax

the query must be a valid map-filter-reduce

example queries

these queries are in JSON format so you can use them via the cli, sbot '{QUERY}' be sure to use single quotes around the query so that the json is property escaped. otherwise, run these queries by passing them to{query: QUERY}) and taking the output as a pull-stream.

all feeds mentioned

returns an stream of {name, feed, uses}

  {"$filter": {
    "rel": ["mentions", {"$prefix": "@"}]

    "name": ["rel", 1], "feed": "dest", "uses": {"$count": true}

thread contributors

returns feeds in each thread, and how many posts they have made. return object in form of {[thread_id]:{[poster]:count}}

  {"$filter": {
    "rel": ["root"]
    "thread": "dest", "participant": "source", "posts": {"$count": true}

names used for "@EMovhfIr...=.ed25519" and who mentioned them.

  {"$filter": {
    "rel": ["mentions", {"$prefix": "@"}],
    "dest": "@EMovhfIrFk4NihAKnRNhrfRaqIhBv1Wj8pTxJNgvCCY=.ed25519"
  {"$reduce": {
    "name": ["rel", 1], "by": "source", "uses": {"$count": true}



results matching ""

    No results matching ""