Quick start

1. Authenticate

Create an API token in Jenkins, then start the interactive connection setup:

jenkins login

Or configure a non-interactive environment for CI and coding agents:

export JENKINS_URL=https://jenkins.example.com
export JENKINS_USER=admin
export JENKINS_TOKEN=11xxxxxxxxxxxxxxxxxx

2. Confirm connectivity

jenkins whoami -o json
jenkins status -o json

3. Discover jobs

Jenkins folders use slash-separated paths such as team/deploy:

jenkins job list --recursive
jenkins job list --recursive --status FAILURE -o json
jenkins job get team/deploy -o yaml

4. Trigger and inspect a build

jenkins job build team/deploy --param ENV=staging --wait --follow
jenkins build list team/deploy --limit 10 -o json
jenkins build get team/deploy 42 -o json
jenkins build log team/deploy 42

Discovering commands

Every command has -h/--help:

jenkins --help
jenkins job --help
jenkins job build --help

Output formats

table, json, yaml, raw output, and structured errors.

Commands

The command surface, grouped by operational area.