Content-type: text/html Man page of seeks cli

seeks cli

Section: (1)
Updated: 2011-10-08
Index Return to Main Contents

NAME

seeks_cli - the Seeks command line interaction tool.

SYNOPSIS

seeks_cli [--timeout seconds] [--proxy add:port] [--output html,json,xml] [--x get,put,delete,post] [command] [url] [query] [args] seeks_cli info seeks_cli peers seeks_cli [--x get] recommend [url] [query] [--nreco nreco] [--radius radius] [--peers local|ring] [--lang lang] [--order rank|new-date|old-date|new-activity|old-activity] seeks_cli [--x post] recommend [url] [query] [--title title] [--radius radius] [--peers local|ring] [--lang lang] [--url-check 0|1] seeks_cli [--x delete] recommend [url] [query] [--url url] [--lang lang] seeks_cli suggest [url] [query] [--nsugg nsugg] [--radius radius] [--peers local|ring] seeks_cli [--x get,put,delete,post] search [url] [query] [--sid snippet_id] [--surl url] [--engines engines] [--rpp rpp] [--page page] [--prs on|off] [--lang lang] [--thumbs on|off] [--expansion expansion] [--peers local|ring] [--order rank|new-date|old-date|new-activity|old-activity] [--redirect url] [--cpost url] seeks_cli words [url] [query] [--sid snippet_id] [--surl url] [--lang lang] seeks_cli recent_queries [url] [--nq nq] seeks_cli cluster_types [url] [query] [--lang lang] seeks_cli cluster_auto [url] [query] [--nclusters nclusters] [--lang lang] seeks_cli similar [url] [query] [--sid snippet_id] [--surl url] [--lang lang] seeks_cli cache [url] [query] [--url url] [--lang lang]

DESCRIPTION

Seeks CLI is a command line client for controlling remote seeks servers through Seeks API. Seeks is an open source:

* websearch proxy and meta-search engine,

* real-time p2p pattern matching network for social websearch.

The Seeks CLI uses the Seeks API to interact with remote Seeks servers. The API can be found here: http://seeks-project.info/wiki/index.php/API-0.4.0

COMMANDS

Every command interacts with different resources on the remote Seeks server.

info: Requests server general information.
peers: Requests the list of configured peers that form the P2P ring of the remote server.
recommend: Get, post or delete a search result from / to the remote server.
suggest: Request a set of query suggestions from the remote server's P2P ring.
search: Get, post or delete queries and search results from the remote server's data feeds and its P2P ring. The remote server's feeds can range from search engines to websites, wikis, ...
words: Requests a list of most discriminating words for a given query.
recent_queries: Requests the set of recent queries that were issued on the remote server.
cluster_types: Requests a grouping of search results by type (webpages, wikis, files, videos, ...).
cluster_auto: Requests an automatic grouping and labeling of results. Experimental.
similar: Requests an ordered selection of search results that are the most similar to a given search result.
cache: Requests a full Web page if it is available from the remote server's cache.

ARGUMENTS

url: The URL of the remote Seeks server to interact with.
query: The query string to the remote Seeks server.

OPTIONS

--help: show this help message and exit.
--timeout timeout: Sets the timeout of server call, in seconds.
--proxy add:port: Specifies a proxy through which to connect to the remote server. Format is host address and port separated with ':'. To connect to a remote proxy Seeks server, use http://s.s/ as the remote url
--output html,json,xml: Specifies the output format, HTML, JSON or XML.
--x get,put,delete,post: Specifies the HTTP method used to interact with the remote Seeks server.
--nreco nreco: Specifies the number of recommendations (aka search results) requested.
--radius radius: Specifies the similarity radius that is applied around the requested queries, and used to generate the recommended set of results. The higher the radius, the lower the precision, the higher the number of returned results.
--peers local|ring: Specifies whether to get results from the remote Seeks server only, with the 'local' parameter, or from the P2P 'ring'. 'ring' is the default.
--lang lang: Specifies an ISO-639 language code, e.g. en, fr, es, ...
--order rank|new-date|old-date|new-activity|old-activity: Specifies the ranking applied to the returned set of search results. rank ranks according to Seeks internal collaborative filter. new-date ranks newly posted results first, the opposite returned by old-date. new-activity ranks most recently accessed results first, the opposited returned by old-activity.
--title title: Specifies the title of a search result URL when posting it on the remote Seeks server.
--url-check 0|1: When posting a search result URL, requests that the remote Seeks server checks on the URL by retrieving its content and title (1), or not (0). Note: the server can choose to ignore the --url-check 0 option.
--url url: Specifies a URL to post, using the recommend command, or to retrieve, using the 'cache' command.
--nsugg nsugg: Specifies the maximum number of requested query suggestions.
--sid snippet_id: Specifies a search result id. The id is a unique identifier attributed by the Seeks server to every search result.
--surl url: Specifies a search result URL. The CLI automatically computes the search snippet id (see --sid) and passes it to the server.
--engines engines: A list of comma separated data feed and engine names to select results from. To know which engines are active on a remote Seeks server, use the info command.
--rpp rpp: Specifies the number of search results returned per page.
--page page: Specifies which (virtual) page of results to return. Along with (--rpp) this option is useful when dealing with large number of search results.
--prs on | off: Specifies whether or not to apply the P2P (or local) collaborative filter to the selection and ranking of results. Using 'off' turns the remote Seeks server into a meta-search engine (if configured that way). To select among the P2P and local collaborative filter, use the (--peers) option.
--thumbs thumbs: Specifies whether to include a link to a search result thumbnails, for every returned result.
--expansion expansion: Using the search command, specifies the depth of the search. Technically, it asks the remote server to retrieve more results from the data feeds and engines it is connected to, and to enlarge the similarity radius of the query search accordingly. (see --radius for the equivalent parameter targeted at the P2P ring only).
--redirect url: TODO
--cpost url: Specifies a Seeks remote server different than the one being called to which cross-post the posted search result. Apply to the recommend command, along with '--x post'.
--nq nq: Specifies the maximum number of requested recent queries.
--nclusters nclusters: Specifies the maximum number of groups (aka. clusters) when issuing a call with the cluster_auto command.

COPYRIGHT

This manual page was written by Emmanuel Benazera

This document was created by man2html, using the manual pages.
Time: 18:04:46 GMT, November 12, 2011