Skip to content

Commit

Permalink
Added installation, config, and usage info to README.
Browse files Browse the repository at this point in the history
  • Loading branch information
cliffano committed Jul 16, 2011
1 parent 7e9c792 commit e073c28
Showing 1 changed file with 55 additions and 1 deletion.
56 changes: 55 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,55 @@
TODO
Nestor
------

Jenkins NodeJS CLI

Overview
--------

Nestor is a Jenkins command-line interface written in NodeJS.

Installation
------------

npm install -g nestor

Config
------

You can set Jenkins URL as an environment variable.

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

By default, Nestor uses http://localhost:8080 as the Jenkins URL.

Usage
-----

View status of all jobs.

nestor dashboard

View job status.

nestor job jobname

Trigger a build.

nestor build jobname

Trigger a parameterised build.

nestor build jobname "param1=value1&param2=value2"

View the build queue.

nestor queue

View the executors' activity (running builds) .

nestor executor

View Jenkins version number.

nestor version

0 comments on commit e073c28

Please sign in to comment.