README.md 2.6 KB
Newer Older
LinuxSuRen's avatar
LinuxSuRen 已提交
1 2
# Jenkins CLI

3
[![Go Report Card](https://goreportcard.com/badge/jenkins-zh/jenkins-cli)](https://goreportcard.com/report/jenkins-zh/jenkins-cli)
LinuxSuRen's avatar
LinuxSuRen 已提交
4
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=jenkins-zh_jenkins-cli&metric=alert_status)](https://sonarcloud.io/dashboard?id=jenkins-zh_jenkins-cli)
5
![Sonar Coverage](https://img.shields.io/sonar/coverage/jenkins-zh_jenkins-cli?server=https%3A%2F%2Fsonarcloud.io)
LinuxSuRen's avatar
LinuxSuRen 已提交
6 7 8
[![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)
9 10
![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 已提交
11
[![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 已提交
12

LinuxSuRen's avatar
LinuxSuRen 已提交
13 14 15 16 17 18
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
19 20 21 22 23
* 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 已提交
24

25
# Get it
LinuxSuRen's avatar
LinuxSuRen 已提交
26

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

29 30 31
## mac

You can use `brew` to install jcli.
LinuxSuRen's avatar
LinuxSuRen 已提交
32
```
33
brew tap jenkins-zh/jcli
LinuxSuRen's avatar
LinuxSuRen 已提交
34 35
brew install jcli
```
LinuxSuRen's avatar
LinuxSuRen 已提交
36

37
## Linux
38

39 40
It's very simple to install `jcli` into your Linux OS. Just need to execute a command line at below:
```
41
curl -L https://github.com/jenkins-zh/jenkins-cli/releases/latest/download/jcli-linux-amd64.tar.gz|tar xzv
42 43 44 45 46
sudo mv jcli /usr/local/bin/
```

## Windows

47
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.
48

LinuxSuRen's avatar
LinuxSuRen 已提交
49 50 51 52 53 54
## Other Package Managers

Here're other package managers:

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

55 56
# Get started

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

LinuxSuRen's avatar
LinuxSuRen 已提交
59 60
# Contribution

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