README.md 1.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)
LinuxSuRen's avatar
LinuxSuRen 已提交
5

LinuxSuRen's avatar
LinuxSuRen 已提交
6 7 8 9 10 11
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
12 13 14 15 16
* 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 已提交
17

18
# Get it
LinuxSuRen's avatar
LinuxSuRen 已提交
19

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

22 23 24
## mac

You can use `brew` to install jcli.
LinuxSuRen's avatar
LinuxSuRen 已提交
25
```
26
brew tap jenkins-zh/jcli
LinuxSuRen's avatar
LinuxSuRen 已提交
27 28
brew install jcli
```
LinuxSuRen's avatar
LinuxSuRen 已提交
29

30
## Linux
31

32 33
It's very simple to install `jcli` into your Linux OS. Just need to execute a command line at below:
```
34
curl -L https://github.com/jenkins-zh/jenkins-cli/releases/latest/download/jcli-linux-amd64.tar.gz|tar xzv
35 36 37 38 39
sudo mv jcli /usr/local/bin/
```

## Windows

40
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.
41

LinuxSuRen's avatar
LinuxSuRen 已提交
42 43 44 45 46 47
## Other Package Managers

Here're other package managers:

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

48 49
# Get started

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

LinuxSuRen's avatar
LinuxSuRen 已提交
52 53 54
# Contribution

It's still under very early develope time. Any contribution is welcome.