Permalink
Browse files

Improve usage info.

  • Loading branch information...
1 parent fb639cb commit 7b93b1c73f9c03f3931972039ba5074c31ee37ef @cliffano committed Jan 22, 2013
Showing with 17 additions and 17 deletions.
  1. +6 −6 README.md
  2. +10 −10 conf/commands.json
  3. +1 −1 package.json
View
@@ -15,31 +15,31 @@ Usage
Trigger a build:
- nestor build <jobname>
+ nestor build <job>
Trigger a parameterised build:
- nestor build <jobname> ["param1=value1&param2=value2"]
+ nestor build <job> ["param1=value1&param2=value2"]
Trigger a build followed by console output:
- nestor build --console <jobname>
+ nestor build --console <job>
Display latest build console output:
- nestor console <jobname>
+ nestor console <job>
Stop currently running build:
- nestor stop <jobname>
+ nestor stop <job>
View status of all jobs:
nestor dashboard
View job status reports:
- nestor job <jobname>
+ nestor job <job>
View queued jobs:
View
@@ -1,7 +1,7 @@
{
"commands": {
"build": {
- "desc": "Trigger a build with optional parameters\n\tnestor build <jobname> [\"param1=value1&param2=value2\"]",
+ "desc": "Trigger a build with optional parameters\nUsage: nestor build [-c/--console] <job> [\"param1=value1&param2=value2\"]",
"options": [
{
"arg": "-c, --console",
@@ -10,31 +10,31 @@
]
},
"console": {
- "desc": "Display latest build console output\n\tnestor console <jobname>"
+ "desc": "Display latest build console output\nUsage: nestor console <job>"
},
"stop": {
- "desc": "Stop the currently running build\n\tnestor stop <jobname>"
+ "desc": "Stop the currently running build\nUsage: nestor stop <job>"
},
"dashboard": {
- "desc": "View status of all jobs\n\tnestor dashboard"
+ "desc": "View status of all jobs\nUsage: nestor dashboard"
},
"discover": {
- "desc": "Discover Jenkins instance running on a specified host\n\tnestor discover <host>"
+ "desc": "Discover Jenkins instance running on a specified host\nUsage: nestor discover <host>"
},
"executor": {
- "desc": "View executors' status (running builds)\n\tnestor executor"
+ "desc": "View executors' status (running builds)\nUsage: nestor executor"
},
"job": {
- "desc": "View job status reports\n\tnestor job <jobname>"
+ "desc": "View job status reports\nUsage: nestor job <job>"
},
"queue": {
- "desc": "View queued jobs\n\tnestor queue"
+ "desc": "View queued jobs\nUsage: nestor queue"
},
"ver": {
- "desc": "View Jenkins version number\n\tnestor ver"
+ "desc": "View Jenkins version number\nUsage: nestor ver"
},
"irc": {
- "desc": "Start an IRC bot\n\tnestor irc <host> <channel> [nick]"
+ "desc": "Start an IRC bot\nUsage: nestor irc <host> <channel> [nick]"
}
}
}
View
@@ -51,4 +51,4 @@
"url": "http://github.com/cliffano/nestor/raw/master/LICENSE"
}
]
-}
+}

0 comments on commit 7b93b1c

Please sign in to comment.