{"_id":"@brandandcelebrities/nestorbc","_rev":"3-dbcda16bc4b03881db0b4d745b185e5c","name":"@brandandcelebrities/nestorbc","description":"Jenkins CLI and node.js client","dist-tags":{"latest":"1.0.3"},"versions":{"1.0.3":{"name":"@brandandcelebrities/nestorbc","description":"Jenkins CLI and node.js client","keywords":["jenkins","ci","cli","api","client"],"version":"1.0.3","homepage":"http://github.com/cliffano/nestor","author":{"name":"Cliffano Subagio","email":"blah@cliffano.com","url":"http://blog.cliffano.com"},"contributors":[{"name":"All contributors","url":"https://github.com/cliffano/nestor/graphs/contributors"}],"main":"./lib/jenkins","bin":{"nestorbc":"./bin/nestor"},"preferGlobal":true,"repository":{"type":"git","url":"git+ssh://git@github.com/cliffano/nestor.git"},"bugs":{"url":"http://github.com/cliffano/nestor/issues"},"directories":{"bin":"./bin","lib":"./lib","test":"./test"},"dependencies":{"async":"^2.1.1","bagofcli":"^1.0.0","bagofrequest":"^1.0.0","bagoftext":"^0.1.2","colors":"^1.1.2","commander":"^2.9.0","cron":"^1.1.1","feed-read":"^0.0.1","lodash":"^4.16.4","moment":"^2.15.1","request":"^2.75.0","xml2js":"^0.4.17"},"devDependencies":{"buster-node":"^0.7.1","proxyquire":"^1.7.10","referee":"^1.2.0"},"scripts":{},"engines":{"node":">= 4.0.0"},"licenses":[{"type":"MIT","url":"http://github.com/cliffano/nestor/raw/master/LICENSE"}],"gitHead":"c916e8b0a1c3f112b1db44ed55cc48f810df0eb8","_id":"@brandandcelebrities/nestorbc@1.0.3","_npmVersion":"5.0.1","_nodeVersion":"7.10.0","_npmUser":{"name":"brandandcelebrities","email":"dev@brandandcelebrities.com"},"dist":{"integrity":"sha512-3MWMmIunriCtse+8yKkmKcK0omF5p8wQJZGqdftjEJrh51YtbZTmo+IHCll74D2cPwFzfVj5FumcJJIx6y8zFg==","shasum":"ab5622b9ef094db1e3f3da13ae6084aee137331f","tarball":"https://registry.npmjs.org/@brandandcelebrities/nestorbc/-/nestorbc-1.0.3.tgz","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIARmw93IXWFggkxC7YTJN5Zah+YKxlG9FWrOEBDfjNZNAiEA1cgyHAG++LgKV/4q/vb5sEPX44wVA9eglAaXKrE26lM="}]},"maintainers":[{"name":"brandandcelebrities","email":"dev@brandandcelebrities.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/nestorbc-1.0.3.tgz_1496325994856_0.6329526747576892"}}},"readme":"<img align=\"right\" src=\"https://raw.github.com/cliffano/nestor/master/avatar.jpg\" alt=\"Avatar\"/>\n\n[![Build Status](https://img.shields.io/travis/cliffano/nestor.svg)](http://travis-ci.org/cliffano/nestor)\n[![Dependencies Status](https://img.shields.io/david/cliffano/nestor.svg)](http://david-dm.org/cliffano/nestor)\n[![Coverage Status](https://img.shields.io/coveralls/cliffano/nestor.svg)](https://coveralls.io/r/cliffano/nestor?branch=master)\n[![Published Version](https://img.shields.io/npm/v/nestor.svg)](http://www.npmjs.com/package/nestor)\n<br/>\n[![npm Badge](https://nodei.co/npm/nestor.png)](http://npmjs.org/package/nestor)\n\nNestor\n------\n\nNestor is a [Jenkins](http://jenkins-ci.org) CLI and node.js client.\n\nThis is handy for Jenkins users who prefer to touch type on the command line over GUI and mouse clicks on the browser. It also serves as an alternative to Jenkins Java CLI where Nestor has shorter commands and executes faster.\n\nInstallation\n------------\n\n    npm install -g nestor\n\nUsage\n-----\n\nTrigger a build:\n\n    nestor build <job>\n\nTrigger a parameterised build:\n\n    nestor build <job> [\"param1=value1&param2=value2\"]\n\nTrigger a build followed by console output:\n\n    nestor build --console <job>\n\nTrigger a build, wait for 5 seconds, then display console output:\n\n    nestor build --pending 5000 --console <job>\n\nTrigger a parameterised build followed by console output:\n\n    nestor build <job> [\"param1=value1&param2=value2\"] --console\n\nDisplay latest build console output:\n\n    nestor console <job>\n\nDisplay console output of a particular build number:\n\n    nestor console <job> [build_number]\n\nStop currently running build:\n\n    nestor stop <job>\n\nView status of all jobs:\n\n    nestor dashboard\n\nView job status reports:\n\n    nestor job <job>\n\nEnable a job:\n\n    nestor enable <job>\n\nDisable a job:\n\n    nestor disable <job>\n\nCreate a new job with a specified config.xml:\n\n    nestor create <job> <path/to/config.xml>\n\nUpdate an existing job with a specified config.xml:\n\n    nestor update <job> <path/to/config.xml>\n\nCopy an existing job1 to a new job2:\n\n    nestor copy <job1> <job2>\n\nDelete an existing job:\n\n    nestor delete <job>\n\nFetch the config.xml of an existing job: (experimental)\n\n    nestor config <job>\n\nCreate a new view with a specified config.xml: (experimental)\n\n    nestor create-view <view> <path/to/config.xml>\n\nUpdate an existing view with a specified config.xml: (experimental)\n\n    nestor update-view <view> <path/to/config.xml>\n\nFetch the config.xml of an existing view: (experimental)\n\n    nestor fetch-view-config <view>\n\nView queued jobs:\n\n    nestor queue\n\nView executors' status (running builds):\n\n    nestor executor\n\nDiscover Jenkins instance running on a specified host:\n\n    nestor discover <host>\n\nView Jenkins version number:\n\n    nestor ver\n\nView builds feed of all jobs:\n\n    nestor feed\n\nView builds feed of a job:\n\n    nestor --job <job> feed\n\nMonitor build status and notify Ninja Blocks RGB LED device:\n\n    export NINJABLOCKS_TOKEN=<token_from_https://a.ninja.is/hacking>\n    nestor ninja\n\nProgrammatically:\n\n    var nestor = new (require('nestor'))(\n      'http://user:pass@host:port/path'\n    );\n\n    // trigger a standard build\n    nestor.buildJob('job', '', function (err, result) {\n    });\n\n    // trigger a parameterised build\n    nestor.buildJob('job', 'param1=value1&param2=value2', function (err, result) {\n    });\n\nCheck out [lib/jenkins](https://github.com/cliffano/nestor/blob/master/lib/jenkins.js) for other available methods.\n\nNote: `<job>` in the examples is a part of your Jenkins job URL after the first `job/`.\n\nFor example, if you use nested folders on Jenkins and your URL is `/job/myproject/job/releases/job/master`,\nthen you should pass `myproject/job/releases/job/master` as `<job>`.\n\nConfiguration\n-------------\n### Jenkins URL\n\nSet Jenkins URL in JENKINS_URL environment variable (defaults to http://localhost:8080):\n\n(*nix)\n\n    export JENKINS_URL=http://user:pass@host:port/path\n\n(Windows)\n\n    set JENKINS_URL=http://user:pass@host:port/path\n\nAs an alternative to password, you can use Jenkins API token instead. Jenkins API token can be found on Jenkins user configuration page.\n\nIf http_proxy or https_proxy environment variable is set, then Nestor will automatically use it.\n\nIf you want authentication details to be prompted interactively:\n\n    JENKINS_URL=http://host:port/path nestor --interactive build job\n\nJenkins URL can also be specified as an arg:\n\n    nestor --url http://user:pass@host:port/path dashboard\n\n### SSL client certificate authentication\n\nSet JENKINS_CERT and JENKINS_KEY\n\n(*nix)\n\n    export JENKINS_CERT=certificate.pem\n    export JENKINS_KEY=key.pem\n\n(Windows)\n\n    set JENKINS_CERT=certificate.pem\n    set JENKINS_KEY=key.pem\n\nWhen you have both key and certificate in one file, currently you have to set both ENV variables to the same file\n\n(*nix)\n\n    export JENKINS_CERT=combined.pem\n    export JENKINS_KEY=combined.pem\n\n(Windows)\n\n    set JENKINS_CERT=combined.pem\n    set JENKINS_KEY=combined.pem\n\nIt is possible to specify a custom CA. Just set the JENKINS_CA env variable\n\n(*nix)\n\n    export JENKINS_CA=custom.ca.pem\n\n(Windows)\n\n    set JENKINS_CA=custom.ca.pem\n\nTranslation\n-----------\n\nTo add a new language translation:\n\n1. Create a locale JSON file in conf/locales/ directory, with the locale's [ISO 639-1 code](http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) as file name.\n2. Copy paste the content of the existing non-English locale file (anything other than en.json) and modify the translation values accordingly.\n3. Test by executing a command with LANG environment variable, e.g. `LANG=<code> nestor dashboard`\n\nContribution\n------------\n\nWhen opening an issue to report a bug, please provide the following information:\n\n* node.js version: `node --version`\n* npm version: `npm --version`\n* Nestor version: `nestor --version`\n* Jenkins version: `nestor ver`\n\nThanks in advance for reporting an issue, opening a feature request, or even better, a pull request!\n\nColophon\n--------\n\n[Developer's Guide](http://cliffano.github.io/developers_guide.html#nodejs)\n\nBuild reports:\n\n* [Code complexity report](http://cliffano.github.io/nestor/complexity/plato/index.html)\n* [Unit tests report](http://cliffano.github.io/nestor/test/buster.out)\n* [Test coverage report](http://cliffano.github.io/nestor/coverage/buster-istanbul/lcov-report/lib/index.html)\n* [Integration tests report](http://cliffano.github.io/nestor/test-integration/cmdt.out)\n* [API Documentation](http://cliffano.github.io/nestor/doc/dox-foundation/index.html)\n\nArticles:\n\n* [Nestor – A Faster And Simpler CLI For Jenkins](http://blog.cliffano.com/2011/10/22/nestor-a-faster-and-simpler-cli-for-jenkins/)\n* [Monitor Jenkins From The Terminal](http://blog.cliffano.com/2013/09/13/monitor-jenkins-from-the-terminal/)\n* [Using Node.js To Discover Jenkins On The Network](http://blog.cliffano.com/2011/08/04/using-nodejs-to-discover-jenkins-on-the-network/)\n\nVideos:\n\n* [Evolution of nestor (Gource Vizualisation)](https://www.youtube.com/watch?v=omwXDBnjp5A) by Landon Wilkins\n\nRelated Projects:\n\n* [nestor-buildlight](http://github.com/cliffano/nestor-buildlight) - CLI for Jenkins build light notifier\n* [nestor-lifx](http://github.com/cliffano/nestor-lifx) - CLI for Jenkins LIFX notifier\n* [nestor-ninjablocks](http://github.com/cliffano/nestor-ninjablocks) - CLI for Jenkins Ninja Blocks notifier\n","maintainers":[{"name":"brandandcelebrities","email":"dev@brandandcelebrities.com"}],"time":{"modified":"2022-04-04T20:22:06.885Z","created":"2017-06-01T14:06:36.016Z","1.0.3":"2017-06-01T14:06:36.016Z","1.0.4":"2017-06-01T14:39:48.143Z"},"homepage":"http://github.com/cliffano/nestor","keywords":["jenkins","ci","cli","api","client"],"repository":{"type":"git","url":"git+ssh://git@github.com/cliffano/nestor.git"},"contributors":[{"name":"All contributors","url":"https://github.com/cliffano/nestor/graphs/contributors"}],"author":{"name":"Cliffano Subagio","email":"blah@cliffano.com","url":"http://blog.cliffano.com"},"bugs":{"url":"http://github.com/cliffano/nestor/issues"},"readmeFilename":"README.md"}