zzpyjenkins

A CLI tool to interact with Jenkins server for building jobs.

Installation

Using uvx (recommended)

uvx install zzpyjenkins

Or run directly:

uvx --from zzpyjenkins zzpyjenkins --help

From source

uv sync
uv run zzpyjenkins --help

Configuration

Create a config file at ~/.config/zzpyjenkins/config.toml with your Jenkins server configurations:

[work]
url = "https://jenkins.work.com"
username = "myuser"
password = "my-api-token"

[home]
url = "http://localhost:8080"
username = "admin"
password = "admin123"

Use the -s/--server option to select which server to use.

Usage

# Show Jenkins server info
zzpyjenkins -s work info

# List all jobs
zzpyjenkins -s work list

# List jobs with filter
zzpyjenkins -s work list -p "my-project"

# Trigger a build
zzpyjenkins -s work build my-job-name

# Trigger a build with parameters
zzpyjenkins -s work build my-job-name -p BRANCH=main -p ENV=staging

# Get build status
zzpyjenkins -s work status my-job-name

# Get specific build status
zzpyjenkins -s work status my-job-name 123

# Watch build progress
zzpyjenkins -s work watch my-job-name

# List running jobs
zzpyjenkins -s work running

# Show only count of running jobs
zzpyjenkins -s work running -c

Development

# Install dev dependencies
uv sync

# Run tests
uv run pytest

# Format code
uv run ruff format .

# Lint
uv run ruff check .