zenkins 0.4.0

CLI tool for Jenkins. List jobs, check builds, view logs, trigger builds.

zenkins

CLI tool for Jenkins. List jobs, check builds, view logs, trigger builds.

Install

uv tool install zenkins

Setup

Run zenkins init to get started. If no config file exists, it creates one with placeholder values:

url = "http://your-jenkins.example.com"
user = "your-username"
token = "your-api-token"

The config file location depends on your OS:

OS	Path
Linux	~/.config/zenkins/config.toml
macOS	~/Library/Application Support/zenkins/config.toml
Windows	%APPDATA%\zenkins\config.toml

Edit the file with your Jenkins URL, username, and API token, then run zenkins init again to verify connectivity.

Creating an API token

1. Log in to your Jenkins instance
2. Click your username (top right) → Configure
3. Scroll to API Token → Add new Token
4. Give it a name, click Generate, and copy the token

The token is shown only once — paste it into config.toml right away.

Usage

zenkins jobs                        # List all jobs with status
zenkins status <job>                # Show last build info
zenkins builds <job>                # List recent builds
zenkins builds <job> -n 5           # List last 5 builds
zenkins log <job>                   # Show console output (last build)
zenkins log <job> 42                # Show console output for build #42
zenkins queue                       # Show build queue
zenkins build <job>                 # Trigger a build
zenkins failures <job>              # Show failing tests (last build)
zenkins failures <job> 42           # Show failing tests for build #42
zenkins failures <job> 40..45       # Failure summary across build range
zenkins failures <job> -n 10        # Failure summary for last 10 builds
zenkins artifacts <job> -l          # List artifacts (last build)
zenkins artifacts <job> 42 -d ./out # Download artifacts to directory
zenkins artifacts <job> --glob "*.xml" # Download matching artifacts
zenkins artifacts <job> -n 3 --glob "*.png" -l  # List PNGs from last 3 builds

Folder jobs use / syntax: zenkins builds ci/main, zenkins failures ci/main -n 5.

The failures command queries both JUnit/NUnit and Robot Framework test results, grouping them into persistent, intermittent, and one-off failures when using range or -n syntax.

Library usage

import zenkins

s = zenkins.client()
resp = s.get("http://jenkins.example.com/api/json")

License

MIT