Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Added installation, config, and usage info to README.

  • Loading branch information...
commit e073c28b892d659358b79809290b90c92b3b3e21 1 parent 7e9c792
@cliffano authored
Showing with 55 additions and 1 deletion.
  1. +55 −1 README.md
View
56 README.md
@@ -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
+
Please sign in to comment.
Something went wrong with that request. Please try again.