README.md 3.3 KB
Newer Older
LinuxSuRen's avatar
LinuxSuRen 已提交
1 2
[简体中文](https://github.com/jenkins-zh/jenkins-cli/blob/master/README-zh.md)

LinuxSuRen's avatar
LinuxSuRen 已提交
3 4
# Jenkins CLI

LinuxSuRen's avatar
LinuxSuRen 已提交
5 6 7
[![Go Report Card][go-report-card-badge]][go-report-card-url]
[![Quality Gate Status][sonar-badge]][sonar-link]
[![GoDoc][godoc-badge]][godoc-url]
8
![Sonar Coverage](https://img.shields.io/sonar/coverage/jenkins-zh_jenkins-cli?server=https%3A%2F%2Fsonarcloud.io)
LinuxSuRen's avatar
LinuxSuRen 已提交
9 10 11
[![Travis](https://img.shields.io/travis/jenkins-zh/jenkins-cli.svg?logo=travis&label=build&logoColor=white)](https://travis-ci.org/jenkins-zh/jenkins-cli)
[![Contributors](https://img.shields.io/github/contributors/jenkins-zh/jenkins-cli.svg)](https://github.com/jenkins-zh/jenkins-cli/graphs/contributors)
[![GitHub release](https://img.shields.io/github/release/jenkins-zh/jenkins-cli.svg?label=release)](https://github.com/jenkins-zh/jenkins-cli/releases/latest)
12 13
![GitHub All Releases](https://img.shields.io/github/downloads/jenkins-zh/jenkins-cli/total)
![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/jenkins-zh/jenkins-cli)
LinuxSuRen's avatar
LinuxSuRen 已提交
14
[![Gitter](https://badges.gitter.im/jenkinsci/jenkins-cli.svg)](https://gitter.im/jenkinsci/jenkins-cli?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
LinuxSuRen's avatar
LinuxSuRen 已提交
15

J
James.Scott 已提交
16 17
Jenkins CLI allows you manage your Jenkins in an easy way. No matter if you're a plugin
developer, administrator or just a regular user, it is made for you!
LinuxSuRen's avatar
LinuxSuRen 已提交
18 19 20 21

# Features

* Multiple Jenkins support
22 23
* Plugins management (list, search, install, upload)
* Job management (search, build, log)
J
James.Scott 已提交
24
* Open your Jenkins with a browser
25 26
* Restart your Jenkins
* Connection with proxy support
LinuxSuRen's avatar
LinuxSuRen 已提交
27

28
# Get it
LinuxSuRen's avatar
LinuxSuRen 已提交
29

J
James.Scott 已提交
30
We support Mac, Linux and Windows for now.
LinuxSuRen's avatar
LinuxSuRen 已提交
31

J
James.Scott 已提交
32
## Mac
33 34

You can use `brew` to install jcli.
LinuxSuRen's avatar
LinuxSuRen 已提交
35
```
36
brew tap jenkins-zh/jcli
LinuxSuRen's avatar
LinuxSuRen 已提交
37 38
brew install jcli
```
LinuxSuRen's avatar
LinuxSuRen 已提交
39

40
## Linux
41

J
James.Scott 已提交
42
To install `jcli` on your Linux OS, execute the following command:
43
```
44
curl -L https://github.com/jenkins-zh/jenkins-cli/releases/latest/download/jcli-linux-amd64.tar.gz|tar xzv
45 46 47 48 49
sudo mv jcli /usr/local/bin/
```

## Windows

J
James.Scott 已提交
50
You can find the latest version [here](https://github.com/jenkins-zh/jenkins-cli/releases/latest/download/jcli-windows-386.tar.gz). Download the tar file and copy the uncompressed `jcli` directory into your system path.
51

J
James.Scott 已提交
52
## Other package managers
LinuxSuRen's avatar
LinuxSuRen 已提交
53

J
James.Scott 已提交
54
Here are other package managers:
LinuxSuRen's avatar
LinuxSuRen 已提交
55

LinuxSuRen's avatar
LinuxSuRen 已提交
56 57
* [GoFish](https://gofi.sh/) users can use `gofish install jcli`
* [Scoop](https://scoop.sh/) users can use `scoop install jcli`
LinuxSuRen's avatar
LinuxSuRen 已提交
58

59 60
# Get started

J
James.Scott 已提交
61
Read [this document](doc/README.md) for more details on how to use `jcli`.
62

LinuxSuRen's avatar
LinuxSuRen 已提交
63 64
# Contribution

LinuxSuRen's avatar
LinuxSuRen 已提交
65 66
If you're interested in this project. Please go through the
[contribution guide](CONTRIBUTING.md). Any contributions are welcome.
LinuxSuRen's avatar
LinuxSuRen 已提交
67

68 69 70
Thanks to JetBrains for giving us the open source licence.  
[![goland.svg](goland.svg)](https://www.jetbrains.com/?from=jenkins-cli)

LinuxSuRen's avatar
LinuxSuRen 已提交
71 72
# Stargazers over time

LinuxSuRen's avatar
LinuxSuRen 已提交
73 74 75 76 77 78 79 80
[![Stargazers over time](https://starchart.cc/jenkins-zh/jenkins-cli.svg)](https://starchart.cc/jenkins-zh/jenkins-cli)

[go-report-card-url]: https://goreportcard.com/report/jenkins-zh/jenkins-cli
[go-report-card-badge]: https://goreportcard.com/badge/jenkins-zh/jenkins-cli
[sonar-badge]: https://sonarcloud.io/api/project_badges/measure?project=jenkins-zh_jenkins-cli&metric=alert_status
[sonar-link]: https://sonarcloud.io/dashboard?id=jenkins-zh_jenkins-cli
[godoc-url]: https://godoc.org/github.com/jenkins-zh/jenkins-cli
[godoc-badge]: http://img.shields.io/badge/godoc-reference-5272B4.svg?style=flat-square