Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Jenkins CLI and node.js client
JavaScript

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
conf
lib
test-integration
test
.bob.json
.gitignore
.travis.yml
CHANGELOG.md
LICENSE
README.md
package.json

README.md

Nestor http://travis-ci.org/cliffano/nestor

Nestor is a Jenkins CLI and Node.js client.

This is handy for those 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.

Installation

npm install -g nestor

Usage

Trigger a build:

nestor build <job>

Trigger a parameterised build:

nestor build <job> ["param1=value1&param2=value2"]

Trigger a build followed by console output:

nestor build --console  <job>

Display latest build console output:

nestor console <job>

Stop currently running build:

nestor stop <job>

View status of all jobs:

nestor dashboard

View job status reports:

nestor job <job>

View queued jobs:

nestor queue

View executors' status (running builds):

nestor executor

Discover Jenkins instance running on a specified host:

nestor discover <host>

View Jenkins version number:

nestor ver

Start an IRC bot:

nestor irc <host> <channel> [nick]

Programmatically:

var nestor = new (require('nestor'))(
  'http://user:pass@host:port/path'
);

// trigger a parameterised build
nestor.build('job', 'param1=value1&param2=value2', function (err, result) {
});

Check out lib/jenkins for other available methods.

Configuration

Set Jenkins URL in JENKINS_URL environment variable (defaults to http://localhost:8080):

(*nix)

export JENKINS_URL=http://user:pass@host:port/path

(Windows)

set JENKINS_URL=http://user:pass@host:port/path

If http_proxy environment variable is set, then Nestor will automatically use it.

Something went wrong with that request. Please try again.