{"id":19454858,"url":"https://github.com/jerakia/jerakia-client","last_synced_at":"2025-10-29T04:09:34.160Z","repository":{"id":83195269,"uuid":"76169199","full_name":"jerakia/jerakia-client","owner":"jerakia","description":"CLI and Ruby client library for Jerakia Server","archived":false,"fork":false,"pushed_at":"2017-08-15T09:58:08.000Z","size":27,"stargazers_count":0,"open_issues_count":1,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-08T00:58:45.820Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jerakia.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-12-11T11:06:46.000Z","updated_at":"2018-10-05T12:11:15.000Z","dependencies_parsed_at":"2023-06-05T01:15:12.298Z","dependency_job_id":null,"html_url":"https://github.com/jerakia/jerakia-client","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jerakia%2Fjerakia-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jerakia%2Fjerakia-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jerakia%2Fjerakia-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jerakia%2Fjerakia-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jerakia","download_url":"https://codeload.github.com/jerakia/jerakia-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240647190,"owners_count":19834751,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T17:12:16.000Z","updated_at":"2025-10-29T04:09:29.118Z","avatar_url":"https://github.com/jerakia.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# jerakia-client\n\n## Description\n\nA ruby client library and CLI for integrating with Jerakia Server (Jerakia 1.2.0+)\n\nFor more details on Jerakia Server please see [The official Jerakia site](http://jerakia.io)\n\nThis client is for use with Jerakia Server, which ships in 1.2.0, it does not integrate with Jerakia 1.1 or below\n\n## Usage\n\n### Command line\n\n```\nUsage:\n  jerakia-client lookup [KEY]\n\nOptions:\n  H, [--host=HOST]                 # Hostname or IP to connect to\n  P, [--port=PORT]                 # Port to connect to\n  T, [--token=TOKEN]               # Token to use for authorization, if not provided a jerakia.yaml will be searched for (see docs)\n  a, [--api=API]                   # API Version to implement (see docs)\n  p, [--policy=POLICY]             # Lookup policy\n                                   # Default: default\n  n, [--namespace=NAMESPACE]       # Lookup namespace\n  t, [--type=TYPE]                 # Lookup type\n                                   # Default: first\n  s, [--scope=SCOPE]               # Scope handler\n                                   # Default: metadata\n      [--scope-options=key:value]  # Key/value pairs to be passed to the scope handler\n  m, [--merge-type=MERGE_TYPE]     # Merge type\n                                   # Default: array\n  v, [--verbose], [--no-verbose]   # Print verbose information\n  D, [--debug], [--no-debug]       # Debug information to console, implies --log-level debug\n  o, [--output=OUTPUT]             # Output format, yaml, json or msgpack\n                                   # Default: json\n  c, [--content_type=TYPE]         # Content type, json or msgpack\n                                   # Default: json\n\nLookup [KEY] with Jerakia\n```\n\nIt is possible to set some of the global settings in the `jerakia.yaml` config file:\n\n```\n$ cat ~/.jerakia/jerakia.yaml\n---\nclient:\n  token: 'test:bcb4ed451b890d62b7784058ecf75e225c490eef62073a3089f1cbd9db50f9034630b33c7ca06b80'\n  host: 'localhost'\n  port: 9992\n  api: 'v1'\n  proto: 'http'\n  content_type: 'msgpack'\n```\n\n### Ruby bindings\n\n#### `Jeraia::Client.new`\n\nInitiate a new client instance.\n\n```\nclient = Jerakia::Client.new(opts)\n```\n\nOptions can be given as a hash of:\n\n* `host`: Hostname or IP to connect to (default localhost)\n* `port`: Port to connect to (default 9843)\n* `api`: The Jerakia Server API version impemented on the server (default v1)\n* `proto`: The protocol to use, `http` or `https` are supported, `http` is the default.\n* `token`: The authentication token to use in the request,  if no token is specified jerakia-client will look for a `jerakia.yaml` file in `/etc/jerakia` and `~/.jerakia` for a key called `client_token`\n\n\n#### Instance methods\n\nOnce initiated the client can be used with the following instance methods\n\n##### lookup(key, params)\n\n```\nclient.lookup(\"port\", { :namespace =\u003e 'apache' })\n```\n\n`params` is a hash of all of the options specified in the Jerakia Server API for the `/v1/lookup` endpoint\n\n\n## LICENSE\n\nThis software is licensed under the Apache 2.0 license, please see the `LICENSE` file for full details\n\n## Author\n\nWritten and maintained by Craig Dunn \u003ccraig@craigdunn.org\u003e\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjerakia%2Fjerakia-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjerakia%2Fjerakia-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjerakia%2Fjerakia-client/lists"}