jenkins-zh/jenkins-cli

Jenkins CLI allows you to manage your Jenkins in an easy way. Jenkins 命令行客户端

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

jenkins-cli's Issues

建议增加job的list

Add support to show and edit the system message from Jenkins

Cannot generate the sample config file when the config file does not exists

When I execute the cmd ./jcli config -g, will be got an error.

The error output is below:
2019/07/19 11:41:09 error: open /root/.jenkins-cli.yaml: no such file or directory.

The reason should be that the ~/.jenkins-cli.yaml does not exist.

Cannot get the version from jcli plugin search

Add support to list the agents

A suggested solution is below:

jcli agent list

Support to show the progress of the plugins installation

Add support to filter the output of job log output

Need an issue template

Add support to add or del a user

API is /securityRealm/createAccountByAdmin

payload should be json: {"username": "abc", "password1": "abc", "$redact": ["password1", "password2"], "password2": "abc", "fullname": "abc", "email": "[email protected]", "Jenkins-Crumb": "675d33520ed8c07d8ac40e44015a3b2b"}

the request should be POST

Add support to create folder

Add support to download plugins

Add support to set the jenkins name for all cmd

For example: jcli job search keyword -j yourJenkinsName

Add support the language setting with the api request

Add support to view and modify the update center address

Add support stop a job build

Error output when execute restart cmd

有些操作可能需要多次执行，并观察结果，可以添加 watch 功能

增加用于下载 Jenkins.war 的命令

Add support to cancel a job from the queue

Add support to upload a plugin by gving a file path

Add support to show the new plugins

No clear description about how to delete a nested folder

Execute cmd jcli job delete "rick folder" -b. Then will got error output:

status code: 404
2019/07/27 09:24:41 <html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8"/>
<title>Error 404 Not Found</title>
</head>
<body><h2>HTTP ERROR 404</h2>
<p>Problem accessing //job/rick%20folder/doDelete. Reason:
<pre>    Not Found</pre></p><hr><a href="http://eclipse.org/jetty">Powered by Jetty:// 9.4.z-SNAPSHOT</a><hr/>

</body>
</html>

Add support to cli completion

Job build error

[root@master ~]# jcli job search publish |grep demo
      "Name": "test_publish_demo"
      "Name": "ops_auto_dev_go_publish_demo"
      "Name": "ops_auto_pre_go_publish_demo"
      "Name": "ops_all_pkg_java_publish_demo"
      "Name": "ops_auto_dev_go_publish_demo1"
[root@master ~]# jcli job build -n test_publish_demo
? Are you sure to build job test_publish_demo Yes
panic: runtime error: invalid memory address or nil pointer dereference
[signal SIGSEGV: segmentation violation code=0x1 addr=0x8 pc=0x6bf987]

goroutine 1 [running]:
github.com/linuxsuren/jenkins-cli/client.(*JenkinsCore).CrumbHandle(0xc00018fcf0, 0xc0001c6000, 0xd, 0xc000015e80)
 /Users/mac/go/src/github.com/linuxsuren/jenkins-cli/client/core.go:55 +0x47
github.com/linuxsuren/jenkins-cli/client.(*JobClient).Build(0xc00018fcf0, 0x7ffd543466c8, 0x11, 0x1, 0x1)
 /Users/mac/go/src/github.com/linuxsuren/jenkins-cli/client/job.go:72 +0x31b
github.com/linuxsuren/jenkins-cli/app/cmd.glob..func9(0xbdac60, 0xc00016c160, 0x0, 0x2)
 /Users/mac/go/src/github.com/linuxsuren/jenkins-cli/app/cmd/job_build.go:43 +0x235
github.com/spf13/cobra.(*Command).execute(0xbdac60, 0xc00016c100, 0x2, 0x2, 0xbdac60, 0xc00016c100)
 /Users/mac/go/src/github.com/spf13/cobra/command.go:766 +0x2ae
github.com/spf13/cobra.(*Command).ExecuteC(0xbdc1c0, 0x869843, 0x1, 0x0)
 /Users/mac/go/src/github.com/spf13/cobra/command.go:852 +0x2ec
github.com/spf13/cobra.(*Command).Execute(...)
 /Users/mac/go/src/github.com/spf13/cobra/command.go:800
github.com/linuxsuren/jenkins-cli/app/cmd.Execute()
 /Users/mac/go/src/github.com/linuxsuren/jenkins-cli/app/cmd/root.go:40 +0x32
main.main()
 /Users/mac/go/src/github.com/linuxsuren/jenkins-cli/main.go:8 +0x20
[root@master ~]# jcli job build -n test_publish_demo -b
panic: runtime error: invalid memory address or nil pointer dereference
[signal SIGSEGV: segmentation violation code=0x1 addr=0x8 pc=0x6bf987]

goroutine 1 [running]:
github.com/linuxsuren/jenkins-cli/client.(*JenkinsCore).CrumbHandle(0xc00006fcf0, 0xc00014b600, 0xd, 0xc000015e80)
 /Users/m

Add support to list all task types

缺少中文的项目说明文件 README_ZH.md

Require a readme file as the Chinese version

Cannot remove a config item

Need a output that just will print the name

It's very useful when we want to use the pipeline in a shell.

Mess up the output when words are not English

Like below:

number name                   type
0      构建一个自由风格的软件项目          Standalone Projects
1      流水线                    Standalone Projects
2      构建一个多配置项目              Standalone Projects
0      Bitbucket Team/Project Nested Projects
1      文件夹                    Nested Projects
2      GitHub 组织              Nested Projects
3      Gitea Organization     Nested Projects
4      多分支流水线                 Nested Projects

Need a readme file as Chinese language

Add support to view configuration-as-code

触发参数化任务时报错

执行的命令，以及错误提示如下：

jcli job build -n "rick echo"
 Are you sure to build job rick echo Yes
2019/07/18 11:14:38 <html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8"/>
<title>Error 400 Nothing is submitted</title>
</head>
<body><h2>HTTP ERROR 400</h2>
<p>Problem accessing ///job/rick/job/echo/build. Reason:
<pre>    Nothing is submitted</pre></p><hr><a href="http://eclipse.org/jetty">Powered by Jetty:// 9.4.z-SNAPSHOT</a><hr/>

</body>
</html>

Add support to define a suite of plugins

Normally we need to install a suite of plugins. We can provide a suite to let Jenkins administrator easy to install all the plugins which they need.

Support to open Jenkins by interactively

We can allow users to choose one Jenkins from a list which already configured. It's better to allow users to filter by a keyword.

Add support to install a specific version of plugin

Add support to install plugins interactively

Support to list the computer/agents

Add support to create view

Error when executing jcli config

This is my first time to execute this cmd. Error output is below:

2019/07/27 11:40:48 No config file found.
panic: runtime error: invalid memory address or nil pointer dereference
[signal SIGSEGV: segmentation violation code=0x1 addr=0x8 pc=0x13a1945]

goroutine 1 [running]:
github.com/linuxsuren/jenkins-cli/app/cmd.glob..func2(0x1805020, 0xc000091060, 0x1, 0x1)
	/Users/mac/go/src/github.com/linuxsuren/jenkins-cli/app/cmd/config.go:30 +0xd5
github.com/spf13/cobra.(*Command).execute(0x1805020, 0xc000091020, 0x1, 0x1, 0x1805020, 0xc000091020)
	/Users/mac/go/src/github.com/spf13/cobra/command.go:766 +0x2ae
github.com/spf13/cobra.(*Command).ExecuteC(0x1809760, 0x147de42, 0x1, 0x0)
	/Users/mac/go/src/github.com/spf13/cobra/command.go:852 +0x2ec
github.com/spf13/cobra.(*Command).Execute(...)
	/Users/mac/go/src/github.com/spf13/cobra/command.go:800
github.com/linuxsuren/jenkins-cli/app/cmd.Execute()
	/Users/mac/go/src/github.com/linuxsuren/jenkins-cli/app/cmd/root.go:40 +0x32
main.main()
	/Users/mac/go/src/github.com/linuxsuren/jenkins-cli/main.go:8 +0x20

job的create、edit、type不好用，具体报错信息如下

jcli的版本为：v0.0.16

希望能够搜索插件并安装

需要完善流水线的编辑功能

执行命令 jcli plugin 时没有任何提示

对于没有任何逻辑的命令，可以直接输出帮助信息

Add support to show the trends of plugins

缺少输出版本的功能

Allow adding a command as a plugin which not belongs to the Jenkins Core

Generate the document for the jcli cmd

Not give the good info when current user has no permission

Add support to show the updated plugins

Failed when the connection needs a proxy