README.md 3.1 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

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

# Features

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

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

30
We support mac, linux and windows for now.
LinuxSuRen's avatar
LinuxSuRen 已提交
31

32 33 34
## mac

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

42 43
It's very simple to install `jcli` into your Linux OS. Just need to execute a command line at below:
```
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

50
You can find the latest version by [click here](https://github.com/jenkins-zh/jenkins-cli/releases/latest/download/jcli-windows-386.tar.gz). Then download the tar file, cp the uncompressed `jcli` directory into your system path.
51

LinuxSuRen's avatar
LinuxSuRen 已提交
52 53 54 55 56 57
## Other Package Managers

Here're other package managers:

* [GoFish](https://gofi.sh/) users can use `gofish install jcli`.

58 59
# Get started

60
Read [this document](doc/README.md) to know more details about how to use `jcli`.
61

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

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

# Stargazers over time

LinuxSuRen's avatar
LinuxSuRen 已提交
69 70 71 72 73 74 75 76
[![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