This file was generated by README.tpl via yaml-readme, please don't edit it directly!

Quick start

简体中文

Jenkins CLI

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!

• Features
• macOS
• Linux
• Windows
• Plugins
• Contribution
• License

Features

• Multiple Jenkins support
• Plugins management (list, search, install, upload)
• Job management (search, build, log)
• Configuration as Code support
• Open your Jenkins with a browser
• Restart your Jenkins
• Connection with proxy support

Get it

We support macOS, Linux and Windows for now.

macOS

You can use brew to install jcli.

brew tap jenkins-zh/jcli
brew install jcli

Alternatively, you can use MacPorts.

sudo port install jenkins-cli

For MacPorts, add +bash_completion or +zsh_completion for shell completion.

Linux

To install jcli on your Linux OS, execute the following command:

curl -L https://github.com/jenkins-zh/jenkins-cli/releases/latest/download/jcli-linux-amd64.tar.gz|tar xzv
sudo mv jcli /usr/local/bin/

Windows

You can install jcli via scoop or choco.

Or you can also find the latest version from the release page. Download the zip file and copy the uncompressed jcli directory into your system path.

Other package managers

Here are other package managers:

Install	Upgrade	Uninstall	Platform
scoop install jcli			Windows
choco install jcli	choco upgrade jcli	choco uninstall jcli	Windows
snap install jcli	snap refresh jcli	snap remove jcli	Linux
sudo port install jenkins-cli	sudo port selfupdate && sudo port upgrade jenkins-cli	sudo port uninstall jenkins-cli	macOS

See more about how to download jcli. You can find the download details from here.

Get started

Read the official document for more details on how to use jcli.

Or, you can take a live interactive course of Jenkins CLI.

Plugins

Jenkins CLI could have more features by installing a plugin for it. You can install a plugin by the following command:

jcli config plugin fetch
jcli config plugin install account

All official plugins could be found at here.

Contribution

If you're interested in this project. Please go through the contribution guide. Any contributions are welcome.

Thanks to JetBrains for giving us the open source licence.

Similar Projects

There're a few similar projects that you might be interested in:

• jenni is a Jenkins Personal Assistant
• jenkins-job-cli Easy way to run Jenkins job from the Command Line

Stargazers over time

License