Skip to content

Commit 3bb4fff

Browse files
committed
update README
1 parent 8ffce6f commit 3bb4fff

1 file changed

Lines changed: 6 additions & 11 deletions

File tree

README.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
[![Code Health](https://landscape.io/github/LD250/jenkins-cli-python/master/landscape.svg?style=flat)](https://landscape.io/github/LD250/jenkins-cli-python/master)
55
[![Requirements Status](https://requires.io/github/LD250/jenkins-cli-python/requirements.svg?branch=master)](https://requires.io/github/LD250/jenkins-cli-python/requirements/?branch=master)
66

7+
**Based on**
8+
[python-jenkins](https://git.openstack.org/cgit/openstack/python-jenkins)
9+
710
# Install:
811
```bash
912
git clone https://github.com/LD250/jenkins-cli-python.git
@@ -14,20 +17,12 @@ python setup.py install
1417
# Usage:
1518

1619
```bash
17-
jenkins [-h] [--host jenkins-url] [--username username]
18-
[--password password]
19-
{jobs,queue,building,start,info,set_branch,stop,console} ...
20+
jenkins [-h] [--host jenkins-url] [--username username] [--password password]
21+
{jobs,queue,building,start,info,setbranch,stop,console} ...
2022
```
2123

2224
Server URL, Username and password may be specified either by the command line arguments or in configuration file **(.jenkins-cli)**. Command line arguments has the highest priority, after that the **.jenkins-cli** file from current folder is taking into account. If there is no.jenkins-cli file in current folder, settings will be read from **.jenkins-cli** from the home folder
2325

24-
# Optional arguments:
25-
```bash
26-
-h, --help show this help message and exit
27-
--host jenkins-url Jenkins Server Url
28-
--username username Jenkins Username
29-
--password password Jenkins Password
30-
```
3126

3227
# Available commands:
3328
```bash
@@ -37,7 +32,7 @@ Server URL, Username and password may be specified either by the command line ar
3732
building Build executor status
3833
start Start job
3934
info Job info
40-
set_branch Set SCM branch
35+
setbranch Set SCM branch
4136
stop Stop job
4237
console Show console for last build
4338
```

0 commit comments

Comments
 (0)