Explore Jenkinsclient: A Powerful Cross‑Platform CLI for Jenkins

Overview

Jenkinsclient is an open‑source, cross‑platform command‑line client for Jenkins, written in Python and released under the Mulan Open Source License. The source code is hosted on Gitee (https://gitee.com/hummerstudio/jenkinsclient) and GitHub (https://github.com/hummerstudio/jenkinsclient); the package is published on PyPI.

Key Features

Open source : Mulan Open Source License encourages contributions.

Cross‑platform : Runs on any system with a Python interpreter (Windows, Linux, macOS, Unix).

Multi‑instance support : jenkins config generate creates a configuration file that can hold multiple Jenkins server definitions; the use field selects the default server.

Docker‑style syntax : Commands resemble natural language, e.g., jenkins job build JOB_NAME instead of traditional flag‑based forms.

Rich functionality : Manages server configuration, nodes, plugins, credentials, jobs, queues, executors, and builds.

Command Syntax

Typical Docker‑style commands provided by Jenkinsclient:

jenkins jobs                          // list jobs
jenkins job build JOB_NAME            // trigger a job
jenkins job disable JOB_NAME          // disable a job
jenkins job enable JOB_NAME           // enable a job

jenkins plugins                       // list plugins
jenkins plugin install PLUGIN_NAME    // install a plugin
jenkins plugin uninstall PLUGIN_NAME  // uninstall a plugin
jenkins plugin search KEY_WORD        // search plugins

Installation

Install from PyPI: pip3 install jenkinsclient Or install from source with setuptools:

python setup.py install

Upgrade

pip3 install -U jenkinsclient

Quick Start

Configure Server Information

Run jenkins config generate to create a template configuration file. Edit the file to add one or more Jenkins server entries and set the use field to the default server.

Help and Resource Listing

Use jenkins jobs to list all jobs, jenkins plugins to list all plugins, or run jenkins to see top‑level command groups. Detailed help for a group is obtained with jenkins job or jenkins plugin.

Supported Operations

Server configuration management

Node management

Plugin management (list, install, uninstall, search)

Credential management

Job management (list, build, enable, disable)

Queue management

Executor management

Build management