Package Documentation

Storm Package: synapse-google-search

The following Commands are available from this package. This documentation is generated for version 2.0.0 of the package.

Storm Commands

This package implements the following Storm Commands.

google.search

Perform a Google search based on a query string.

This creates a ``inet:search:query`` node with the `:text` property set to the query string.

Examples:

  // Search based on a given text string
  google.search "Hello world examples"

  // Search based on a given text and yield the results, limited to 10 nodes.
  google.search --yield "Hello world examples"

  // Search google for a exact phrase with quotes
  google.search '"Vertex Project Synapse"'

  // Make a search query from a inbound node. This example searches for md5 hashes on file:bytes nodes.
  file:bytes#some.cool.tag +:md5 $md5=:md5 | google.search $md5


Usage: google.search [options] <query>

Options:

  --help                      : Display the command usage.
  --debug                     : Show verbose debug output.
  --size <size>               : Limit the number of results ingested to the given size.
  --yield                     : Yield the newly created nodes.
  --get-content               : Retrieve content from the URLs returned by the search.

Arguments:

  <query>                     : The query string.

google.search.enrich

Perform a Google search based on the contents of the node's primary property.

This creates a ``inet:search:query`` node with the `:text` property set to the repr of the primary property of
the inbound node.

Examples:

  // Perform a google search for the fqdn vertex.link
  inet:fqdn=vertex.link | google.search.enrich

  // Perform a google search for the fqdn vertex.link and yield the results, limited to 10 nodes.
  inet:fqdn=vertex.link | google.search.enrich --yield | limit 10


Usage: google.search.enrich [options]

Options:

  --help                      : Display the command usage.
  --debug                     : Show verbose debug output.
  --size <size>               : Limit the number of results ingested to the given size (per-node).
  --yield                     : Yield the newly created nodes.
  --get-content               : Retrieve content from the URLs returned by the search.

google.search.setup.apikey

Set the Google Search API key.


Usage: google.search.setup.apikey [options] <apikey>

Options:

  --help                      : Display the command usage.
  --self                      : Set the key as a user variable. If not used, the key is set globally.

Arguments:

  <apikey>                    : The Google Search API key string.

google.search.setup.cx

Set the Google Search CX key.


Usage: google.search.setup.cx [options] <apikey>

Options:

  --help                      : Display the command usage.
  --self                      : Set the key as a user variable. If not used, the key is set globally.

Arguments:

  <apikey>                    : The Google Search CX key string.

Storm Modules

This package does not export any Storm APIs.