jenkins-cli

Jenkins CLI Skill

Use the CLI setup and command format below when constructing all jenkins-cli commands.

Instances

Update the table below with your Jenkins server URLs and auth file paths:

Environment	Server URL	Auth File
Production	https://<your-jenkins-prod-url>	jenkins-cli/prod.auth
Staging	https://<your-jenkins-staging-url>	jenkins-cli/staging.auth

If the target server is unclear, ask the user before running any command.

CLI Setup

• JAR File: jenkins-cli/jenkins-cli.jar (working directory's root)
• Auth Files: one per server — see instance table above. File contents format: username:api-token

All commands must be run from the working directory's root (where jenkins-cli/ directory exists).

Prerequisites (one-time setup by user)

If the jenkins-cli/ directory does not exist yet, or jenkins-cli.jar or the auth file for the target server is missing, inform the user that setup is required and ask them to complete the following steps manually. Do not perform these steps yourself.

1. Create the directory jenkins-cli in the working directory's root.
2. Download the JAR from <YOUR_JENKINS_URL>/jnlpJars/jenkins-cli.jar and save it as jenkins-cli/jenkins-cli.jar.
3. Create an auth file for each server you intend to use, with your credentials in this exact format: username:api-token
   • jenkins-cli/prod.auth
   • jenkins-cli/staging.auth

Command Format

java -jar jenkins-cli/jenkins-cli.jar -s <SERVER_URL> -auth @<AUTH_FILE> [command]

Example (production):

java -jar jenkins-cli/jenkins-cli.jar -s https://<your-jenkins-prod-url> -auth @jenkins-cli/prod.auth who-am-i

Available Commands

Read-only (safe, no confirmation needed)

Command	Description
who-am-i	Verify auth and show permissions
version	Show Jenkins version
list-jobs [folder]	List all jobs (optionally in a folder/view)
get-job <job>	Dump job config XML to stdout
console <job> [build#]	Get console output of a build; build# accepts integers or Jenkins specifiers like lastSuccessfulBuild, lastBuild, lastFailedBuild
list-changes <job> [build#]	Show changelog for a build; build# must be an integer — specifiers like lastSuccessfulBuild are not accepted
get-node <node>	Dump node config XML
get-view <view>	Dump view config XML
list-plugins	List installed plugins
session-id	Show current session ID
export-configuration	Export Jenkins config as YAML
check-configuration	Validate YAML configuration
declarative-linter	Validate a Declarative Jenkinsfile (reads from stdin)
list-credentials <store>	List credentials in a store
get-credentials-as-xml <store> <domain> <id>	Get credential XML (secrets redacted)
get-credentials-domain-as-xml <store> <domain>	Get credentials domain XML
list-credentials-context-resolvers	List credentials context resolvers
list-credentials-providers	List credentials providers
help [command]	List all commands or describe one command
reload-job <job>	Reload job config from disk (read-only, no state change)