{"_id":"xgminer","_rev":"35-8415b197c8043fdc2abe9f6d68285b58","name":"xgminer","description":"An npm module to provide an API client for cgminer (supports sgminer/bfgminer)","dist-tags":{"latest":"0.2.3"},"versions":{"0.0.1":{"name":"xgminer","version":"0.0.1","description":"A npm module to provide an API client for cgminer (supports sgminer/bfgminer)","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"https://github.com/brandon-barker/node-xgminer"},"keywords":["cgminer","bfgminer","sgminer","bitcoin","mining","scrypt","litecoin","nodeminer"],"author":{"name":"Brandon Barker"},"license":"BSD-2-Clause","bugs":{"url":"https://github.com/brandon-barker/node-xgminer/issues"},"_id":"xgminer@0.0.1","dist":{"shasum":"345cf5c55ed9200bfef73aa8910ca637f601edf5","tarball":"https://registry.npmjs.org/xgminer/-/xgminer-0.0.1.tgz","integrity":"sha512-oGnj0Rtl69oKNtCMKmTv6AIFpjpRQ1omySyDgshfxW99WMobDpVADH3RSTksFzncZBwGopYVCHkNI2Yy4+2SAA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCYhw/eQyD16ivr+ZfR2/Q/7NB9Hql4R9AL6FW8I1vm8gIhALS4+pF9PaRIjCAuFNWH2cbpo17f4P+6A9gyV41VY0Bt"}]},"_from":".","_npmVersion":"1.3.8","_npmUser":{"name":"brandonbarker","email":"skinty@gmail.com"},"maintainers":[{"name":"brandonbarker","email":"skinty@gmail.com"}]},"0.0.2":{"name":"xgminer","version":"0.0.2","description":"An npm module to provide an API client for cgminer (supports sgminer/bfgminer)","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"https://github.com/brandon-barker/node-xgminer"},"keywords":["cgminer","bfgminer","sgminer","bitcoin","mining","scrypt","litecoin","nodeminer"],"author":{"name":"Brandon Barker"},"license":"BSD-2-Clause","bugs":{"url":"https://github.com/brandon-barker/node-xgminer/issues"},"dependencies":{"lodash":"~2.4.1","q":"~1.0.0"},"_id":"xgminer@0.0.2","dist":{"shasum":"640d3e87e31fa6681db72ea4ce3f1f5b954b7cba","tarball":"https://registry.npmjs.org/xgminer/-/xgminer-0.0.2.tgz","integrity":"sha512-CeW4jCQnVCSd68z3IByCoZ2Kt25LpcZtCfEooxGPdplVP9H0awK7dwG95bYxw8cySkjY5151QkFor4INVPkn2A==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCUct8ofQzpqh4Ga8vXtTF4A7OfdRKDlAKC06RfCMYBfQIgaKypKetEjTgiJ2XDWo80Nb6PUt8LrXtFhwbEvhm0WrY="}]},"_from":".","_npmVersion":"1.3.5","_npmUser":{"name":"brandonbarker","email":"skinty@gmail.com"},"maintainers":[{"name":"brandonbarker","email":"skinty@gmail.com"}]},"0.1.0":{"name":"xgminer","version":"0.1.0","description":"An npm module to provide an API client for cgminer (supports sgminer/bfgminer)","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"https://github.com/brandon-barker/node-xgminer"},"keywords":["cgminer","bfgminer","sgminer","bitcoin","mining","scrypt","litecoin","nodeminer"],"author":{"name":"Brandon Barker"},"license":"BSD-2-Clause","bugs":{"url":"https://github.com/brandon-barker/node-xgminer/issues"},"dependencies":{"lodash":"~2.4.1","q":"~1.0.0"},"_id":"xgminer@0.1.0","dist":{"shasum":"27237ca1858e239fec9f8a029fed74d9b8bec389","tarball":"https://registry.npmjs.org/xgminer/-/xgminer-0.1.0.tgz","integrity":"sha512-epK+1KdW8iNMlAkBMoCY1ldhW5PsUyMZSXl0tL6LTd55JXfbXpjX3MMKQ92BbQl2jUGEb1GluOaVNkP4MuGr2A==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDit1KbuhJYJ0QcowJ8zxeeA8SMqoBQvr9fAV5zeU5kPQIgGMwjWA11uJgKoLcdvKrqL4TCdz1uN+9PmiNe8beb6Jk="}]},"_from":".","_npmVersion":"1.3.5","_npmUser":{"name":"brandonbarker","email":"skinty@gmail.com"},"maintainers":[{"name":"brandonbarker","email":"skinty@gmail.com"}]},"0.2.0":{"name":"xgminer","version":"0.2.0","description":"An npm module to provide an API client for cgminer (supports sgminer/bfgminer)","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"https://github.com/brandon-barker/node-xgminer"},"keywords":["cgminer","bfgminer","sgminer","bitcoin","mining","scrypt","litecoin","nodeminer"],"author":{"name":"Brandon Barker"},"license":"BSD-2-Clause","bugs":{"url":"https://github.com/brandon-barker/node-xgminer/issues"},"dependencies":{"lodash":"~2.4.1","q":"~1.0.0"},"_id":"xgminer@0.2.0","dist":{"shasum":"1ed2242fc9c0f8e607d5aa56f8615e3bea0f48e9","tarball":"https://registry.npmjs.org/xgminer/-/xgminer-0.2.0.tgz","integrity":"sha512-35HPfDEpiIKOOCfmIIfb7TjtnnkRhGacNRprOGWDqZHNk+loJC+ek+mXLoqNTSNHUSeERE9aMV7at1ygBLIJ4g==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBhPvLmlhWZoPy9wJa14Aj7UvKTRzb27LWuhRbFlpiqNAiEAwu8+n/v/HVRCTjpp62I+0ibkwflnZoxkoVHC56Eey8Q="}]},"_from":".","_npmVersion":"1.3.5","_npmUser":{"name":"brandonbarker","email":"skinty@gmail.com"},"maintainers":[{"name":"brandonbarker","email":"skinty@gmail.com"}]},"0.2.1":{"name":"xgminer","version":"0.2.1","description":"An npm module to provide an API client for cgminer (supports sgminer/bfgminer)","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"https://github.com/brandon-barker/node-xgminer"},"keywords":["cgminer","bfgminer","sgminer","bitcoin","mining","scrypt","litecoin","nodeminer"],"author":{"name":"Brandon Barker"},"license":"BSD-2-Clause","bugs":{"url":"https://github.com/brandon-barker/node-xgminer/issues"},"dependencies":{"lodash":"~2.4.1","q":"~1.0.0"},"_id":"xgminer@0.2.1","dist":{"shasum":"758d57e160314e06e4cd970b927b100de03e17d0","tarball":"https://registry.npmjs.org/xgminer/-/xgminer-0.2.1.tgz","integrity":"sha512-YYhEKV4ANq1gxm44hCrUmFA6CKPDcixPS4aqqMA9aJpjMU24fNCS/kv3dqI7aob+7QS3yvGAsLL/gUBJIKYKKw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDCdu5N2srU/iG9pCywQrsk0KDPqUE6xS+R8raPBLDCsAIgSQl6ujttoqZGJODcrtjBmzDsyFaYgcblNkGWpeyD8WU="}]},"_from":".","_npmVersion":"1.3.5","_npmUser":{"name":"brandonbarker","email":"skinty@gmail.com"},"maintainers":[{"name":"brandonbarker","email":"skinty@gmail.com"}]},"0.2.2":{"name":"xgminer","version":"0.2.2","description":"An npm module to provide an API client for cgminer (supports sgminer/bfgminer)","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"https://github.com/brandon-barker/node-xgminer"},"keywords":["cgminer","bfgminer","sgminer","bitcoin","mining","scrypt","litecoin","nodeminer"],"author":{"name":"Brandon Barker"},"license":"BSD-2-Clause","bugs":{"url":"https://github.com/brandon-barker/node-xgminer/issues"},"dependencies":{"lodash":"~2.4.1","q":"~1.0.0"},"_id":"xgminer@0.2.2","dist":{"shasum":"84d08df994d4dccd8d38d0ebb01d6e1dd37e0f18","tarball":"https://registry.npmjs.org/xgminer/-/xgminer-0.2.2.tgz","integrity":"sha512-KdGzfuhE2xaeHiHLEgoxvmDtJ/ePDEJf+W89TYq4ea3ceGhuLMl0eGtV+eAlRBwwinY2hEK7gj+gIuhWQ3524A==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIC6L5ri3af96HBCCbeW6toTgX/cS7hyHXNIbeGPx/QJZAiBPAIzKl82A6cz0zQvnVvlsVUp5ueaJB+UqBMtu7BFJyw=="}]},"_from":".","_npmVersion":"1.3.5","_npmUser":{"name":"brandonbarker","email":"skinty@gmail.com"},"maintainers":[{"name":"brandonbarker","email":"skinty@gmail.com"}]},"0.2.3":{"name":"xgminer","version":"0.2.3","description":"An npm module to provide an API client for cgminer (supports sgminer/bfgminer)","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"https://github.com/brandon-barker/node-xgminer"},"keywords":["cgminer","bfgminer","sgminer","bitcoin","mining","scrypt","litecoin","nodeminer"],"author":{"name":"Brandon Barker"},"license":"BSD-2-Clause","bugs":{"url":"https://github.com/brandon-barker/node-xgminer/issues"},"dependencies":{"lodash":"~2.4.1","q":"~1.0.0"},"_id":"xgminer@0.2.3","dist":{"shasum":"9054008f52b42b4b821795879a96001d10b252af","tarball":"https://registry.npmjs.org/xgminer/-/xgminer-0.2.3.tgz","integrity":"sha512-gXZ5NXKyA69AnulNpvG7ByD89Q+Qcflxo1VWoIZjiNMKDv89aHo7ZJHn/Yy5jsl9FNVjwQBhPuAbk7uodN9Syg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD2IMXRkr4o29/m9IyJWy1xUBe7OLzY3qF2SL1XE6Ib1AIgdJG3y6bYv5OKGG+5EmXyyMmEEIWp99S96BzIEgJZ2/4="}]},"_from":".","_npmVersion":"1.3.5","_npmUser":{"name":"brandonbarker","email":"skinty@gmail.com"},"maintainers":[{"name":"brandonbarker","email":"skinty@gmail.com"}]}},"readme":"(x)gminer\r\n============\r\n\r\n## Purpose\r\n\r\n(x)gminer is a node module which provides an API client for cgminer / sgminer / bfgminer.\r\n\r\nIt's currently focused on scrypt only commands and targeted against cgminer 3.7.2. \r\n\r\nAlthough ASIC / FPGA commands may work, they have not been tested\r\n\r\n## Current Status\r\n\r\nThis module was developed for [nodeminer](https://github.com/brandon-barker/nodeminer), a Web UI for mining scrypt based cryptocurrencies, but will be developed and maintained seperately to provide more usability for the community.\r\n\r\n## Features\r\n\r\n* cgminer / bfgminer / sgminer support\r\n* Supports all scrypt based API commands\r\n* Promise (q) library\r\n\r\n## API Commands\r\n\r\nFor a list of supported API commands take a look at the [commands.json](https://github.com/brandon-barker/node-xgminer/blob/master/lib/config/commands.json) file (proper wiki/documentation coming soon)\r\n\r\n## Installation\r\n\r\nvia [npm](http://github.com/isaacs/npm):\r\n```\r\nnpm install xgminer\r\n```\r\nManually:\r\n```\r\ngit clone git://github.com/brandon-barker/node-xgminer.git xgminer\r\n```\r\n\r\n## Examples\r\n\r\nConnect to cgminer API and return a 'summary'\r\n```javascript\r\nvar xgminer = require('xgminer');\r\n\r\nvar client = new xgminer(host, port);\r\n\r\nclient.summary().then(function (data) {\r\n  console.log(data);\r\n}, function (err) {\r\n  // an error occurred\r\n});\r\n```\r\n\r\nConnect to cgminer API and disable GPU 0\r\n```javascript\r\nvar xgminer = require('xgminer');\r\n\r\nvar client = new xgminer(host, port);\r\n\r\nclient.gpudisable('0').then(function (data) {\r\n  console.log(data);\r\n}, function (err) {\r\n  // an error occurred\r\n});\r\n```\r\n\r\nConnect to cgminer API and zero all stats\r\n```javascript\r\nvar xgminer = require('xgminer');\r\n\r\nvar client = new xgminer(host, port);\r\n\r\nclient.zero('all,true').then(function (data) {\r\n  console.log(data);\r\n}, function (err) {\r\n  // an error occurred\r\n});\r\n```\r\n","maintainers":[{"name":"brandonbarker","email":"skinty@gmail.com"}],"time":{"modified":"2022-06-29T05:09:29.253Z","created":"2014-03-04T09:57:09.196Z","0.0.1":"2014-03-04T09:57:17.916Z","0.0.2":"2014-03-05T19:03:06.507Z","0.1.0":"2014-03-05T19:14:11.975Z","0.2.0":"2014-03-06T09:15:03.653Z","0.2.1":"2014-03-06T10:56:03.022Z","0.2.2":"2014-03-06T13:44:18.621Z","0.2.3":"2014-03-21T15:15:14.563Z"},"readmeFilename":"README.md","keywords":["cgminer","bfgminer","sgminer","bitcoin","mining","scrypt","litecoin","nodeminer"],"repository":{"type":"git","url":"https://github.com/brandon-barker/node-xgminer"},"author":{"name":"Brandon Barker"},"bugs":{"url":"https://github.com/brandon-barker/node-xgminer/issues"},"license":"BSD-2-Clause","users":{"hotsauce":true,"brandonbarker":true}}