A CLI tool for Jenkins
Project description
Jenkins Terminal Tool
A command-line tool for interacting with Jenkins, allowing you to configure Jenkins credentials, trigger builds, and get job statuses.
Features
- Set Jenkins configuration parameters interactively or via command-line options
- Trigger Jenkins jobs with parameters
- Get the status of Jenkins jobs
Installation
Using pip
-
Install the tool:
pip install jenkins-terminal
-
Run the CLI tool:
jenkins <command>
Usage
Configuration
You can set Jenkins configuration parameters either interactively or via command-line options.
Interactively
Run the following command and follow the prompts to enter your Jenkins URL, username, and API token:
jenkins config
Command-line options
You can also set the configuration parameters using command-line options:
jenkins config --username <username> --url <url> --token <token>
Trigger a Jenkins Job
Trigger a Jenkins job with parameters:
jenkins build <job> <key1>=<value1> <key2>=<value2> ...
You can also specify a YAML file containing job parameters:
jenkins build <job> <parameters.yaml>
The YAML file should contain the job parameters in the following format:
key1: value1
key2: value2
Get Jenkins Job Status
Get the status of a Jenkins job:
jenkins status <job>
Acknowledgements
- Typer - CLI library for Python
- Rich - Rich text and beautiful formatting in the terminal
- Jenkins - The leading open source automation server
License
This project is licensed under the MIT License. See the LICENSE file for details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for jenkins_terminal-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c784e071a649028fb406f7ced56caf9cbcf452e6e72627b222cb6619b5d08ad1 |
|
MD5 | 2914a78f69c118399f21d48c5fb372d0 |
|
BLAKE2b-256 | 30279d8fb944cedb94c0defe51cbccc06631631cb928020501e019895f281360 |