Skip to content

Commit 4da45a4

Browse files
committed
更新README文件
1 parent 936aca5 commit 4da45a4

1 file changed

Lines changed: 39 additions & 11 deletions

File tree

README.md

Lines changed: 39 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,30 @@
22

33
# JenkinsClient
44

5-
A powerful cross-platform Jenkins command-line client which supports multiple instances of Jennkins.
5+
A powerful cross-platform Jenkins command-line client which supports multiple instances of Jenkins.
66

77
# Features
88

9-
- Global info
10-
- get Jenkins server version
9+
- Get global info
10+
- get Jenkins server info
1111
- get whoami info
1212
- get plugins info
13-
- get node info
13+
- get nodes info
1414
- get jobs info
1515
- get queues info
16-
- Object operations
16+
- Operating Jenkins objects
1717
- Plugin
1818
- list, search, install, uninstall plugin, and many more operations
19+
- Node
20+
- list, get node info and many more operations
21+
- Executor
22+
- get the number of node's executors, and many more operations
1923
- Job
2024
- list, build, copy, create, delete, disable, enable, rename job, and many more operations
2125
- Queue
2226
- list and cancel queue
2327
- Build
2428
- get env_vars, information, log and test report of build
25-
- ...
2629

2730

2831
# Install
@@ -35,6 +38,14 @@ or manually download the source code and use setuptools:
3538

3639
`python setup.py install`
3740

41+
# Upgrade
42+
43+
`pip3 install -U jenkinsclient`
44+
45+
# Releases
46+
47+
[https://pypi.org/project/jenkinsclient/](https://pypi.org/project/jenkinsclient/)
48+
3849
# Usage
3950

4051
After install jenkinsclient, you can use command `jenkins` to perform many operations on Jenkins server.
@@ -53,7 +64,7 @@ try `jenkins plugins` to see all plugins on your jenkins server.
5364

5465
## Help infomation
5566

56-
Type `jenkins` to show help infomation like this:
67+
Type `jenkins` to show jenkinsclient help information, or `jenkins GROUP` to view group command help information, such as `jenkins config`, `jenkins job`.like this:
5768

5869
```
5970
NAME
@@ -68,28 +79,45 @@ DESCRIPTION
6879
GROUPS
6980
GROUP is one of the following:
7081
82+
build
83+
Jenkins构建相关操作
84+
7185
config
7286
配置信息
7387
88+
executor
89+
Jenkins执行器相关操作
90+
7491
job
7592
Jenkins任务相关操作
7693
94+
node
95+
Jenkins节点相关操作
96+
7797
plugin
7898
Jenkins插件相关操作
7999
100+
queue
101+
Jenkins队列相关操作
102+
80103
COMMANDS
81104
COMMAND is one of the following:
82105
83106
jobs
84107
显示任务列表
85108
109+
nodes
110+
显示节点列表
111+
86112
plugins
87113
显示插件列表
88114
115+
queues
116+
查看队列
117+
118+
version
119+
显示Jenkins服务器版本号
120+
89121
whoami
90122
显示当前用户
91123
```
92-
93-
## Command infomation
94-
95-
You can type `jenkins COMMAND` to view command infomation, such as `jenkins confg`, `jenkins job`.

0 commit comments

Comments
 (0)