A beautiful command-line interface for Jenkins
Project description
🔧 Jenkins CLI
A beautiful, feature-rich command-line interface for Jenkins built with python-jenkins, Click, and Rich.
Features
- 🔐 Secure credential storage (
~/.jenkins-cli/config.json, chmod 600) - 🌿 Environment variable support (
JENKINS_URL,JENKINS_USER,JENKINS_TOKEN) - 📋 List, inspect, enable/disable, copy, delete jobs
- 🚀 Trigger builds with parameters, wait/follow console output
- 📜 View build history and console logs in real-time
- ⏱ Monitor the build queue
- 🖥 List nodes/agents and their status
- 🎨 Rich terminal output with colors, tables, and icons
Installation
pip install python-jenkins-cli
Quick Start
# 1. Configure connection
jenkins-cli config set
# 2. Verify connection
jenkins-cli ping
# 3. List jobs
jenkins-cli job list
Commands
Configuration
jenkins-cli config set # Interactive setup wizard
jenkins-cli config show # Show current config
jenkins-cli config clear # Remove saved config
Job Management
jenkins-cli job list # List all jobs
jenkins-cli job list --folder ci # Filter by folder prefix
jenkins-cli job info my-app # Detailed job info + recent builds
jenkins-cli job enable my-app # Enable a job
jenkins-cli job disable my-app # Disable a job
jenkins-cli job delete my-app # Delete a job (with confirmation)
jenkins-cli job copy src dst # Copy a job
jenkins-cli job config my-app # Show job XML config
jenkins-cli job config my-app -o job.xml # Save XML to file
jenkins-cli job create new-job job.xml # Create job from XML
Build Management
jenkins-cli build trigger my-app # Trigger build
jenkins-cli build trigger my-app -p ENV=prod # With parameters
jenkins-cli build trigger my-app -p A=1 -p B=2 -w # Wait for completion
jenkins-cli build trigger my-app -f # Follow console output
jenkins-cli build info my-app # Last build info
jenkins-cli build info my-app 42 # Specific build info
jenkins-cli build log my-app # Last build log
jenkins-cli build log my-app 42 --follow # Follow log in real-time
jenkins-cli build stop my-app 42 # Stop a build
jenkins-cli build history my-app # Recent build history
Infrastructure
jenkins-cli queue # Show build queue
jenkins-cli nodes # List all nodes/agents
jenkins-cli ping # Test connection
Environment Variables
| Variable | Description |
|---|---|
JENKINS_URL |
Jenkins server URL |
JENKINS_USER |
Jenkins username |
JENKINS_TOKEN |
Jenkins API token |
Environment variables take precedence over the saved config file.
Running Tests
pip install pytest
pytest tests/ -v
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 Distribution
python_jenkins_cli-0.1.0.tar.gz
(12.4 kB
view details)
File details
Details for the file python_jenkins_cli-0.1.0.tar.gz.
File metadata
- Download URL: python_jenkins_cli-0.1.0.tar.gz
- Upload date:
- Size: 12.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9f3b7768bed6b45466a1aa71b96e9030d85ae0eb84dabd1d6573687bb5489b50
|
|
| MD5 |
2cfa755c957c7c192417013c06655013
|
|
| BLAKE2b-256 |
b2b7f28252a6de6f961a655108e030f5612e07b40180c2c7a51930b458d680db
|