README.md 3.9 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
![GitHub All Releases](https://img.shields.io/github/downloads/jenkins-zh/jenkins-cli/total)
LinuxSuRen's avatar
LinuxSuRen 已提交
13
[![Docker Pulls](https://img.shields.io/docker/pulls/jenkinszh/jcli.svg)](https://hub.docker.com/r/jenkinszh/jcli/tags)
14
![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/jenkins-zh/jenkins-cli)
LinuxSuRen's avatar
LinuxSuRen 已提交
15
[![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 已提交
16

J
James.Scott 已提交
17 18
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 已提交
19 20 21 22

# Features

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

30
# Get it
LinuxSuRen's avatar
LinuxSuRen 已提交
31

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

J
James.Scott 已提交
34
## Mac
35 36

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

42
## Linux
43

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

## Windows

52 53
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.
54

J
James.Scott 已提交
55
## Other package managers
LinuxSuRen's avatar
LinuxSuRen 已提交
56

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

LinuxSuRen's avatar
LinuxSuRen 已提交
59 60
* [GoFish](https://gofi.sh/) users can use `gofish install jcli`
* [Scoop](https://scoop.sh/) users can use `scoop install jcli`
61
* [Chocolatey](https://chocolatey.org/packages/jcli) users can use `choco install jcli`
LinuxSuRen's avatar
LinuxSuRen 已提交
62
* [Snapcraft](https://snapcraft.io/jcli) users can use `sudo snap install jcli`
LinuxSuRen's avatar
LinuxSuRen 已提交
63

64
See more about [how to download jcli](doc/download.md).
65
You can find the download details [from here](http://somsubhra.com/github-release-stats/?username=jenkins-zh&repository=jenkins-cli).
66

67 68
# Get started

69
Read the [official document](http://jcli.jenkins-zh.cn/) for more details on how to use `jcli`.
70

71 72
Or, you can take [a live interactive course](https://www.katacoda.com/jenkins-zh/scenarios/course-jcli) of Jenkins CLI.

LinuxSuRen's avatar
LinuxSuRen 已提交
73 74
# Contribution

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

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

LinuxSuRen's avatar
LinuxSuRen 已提交
81 82
# Stargazers over time

LinuxSuRen's avatar
LinuxSuRen 已提交
83 84 85 86 87 88 89 90
[![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