Jenkins CLI allow administrators to perform management actions in headless mode (without UI) and automated it. This documentation explain how to manage your Jenkins with CLI, using the CLI client. Other methods are available, feel free to test it : https://www.jenkins.io/doc/book/managing/cli/
Please log in to Jenkins in your broswer, and visit http://localhost/cli/ You can see on the top of the page a link to download the latest client version : http://localhost/jnlpJars/jenkins-cli.jar
You can download it at the projet root, it will be not commited (disabled in .gitignore file) :
curl "http://localhost/jnlpJars/jenkins-cli.jar" --output jenkins-cli.jarSSH server is disable by default on Jenkins. Please go to http://localhost/configureSecurity/ and in "SSH Server" block, set "8081" and save.
Please note this configuration is activated on this showroom with configuration as code (configuration/security.yml)
A Jenkins user must be configured to logged in Jenkins with CLI. Please access http://localhost/securityRealm/ and create a user or modify one.
For example my user is named "John Doe", with user ID "jdoe". On the user management page, please note field "SSH public keys"
Copy / past your public key in this field and save.
Let's perform a quick test to validate connection with CLI :
# This command display the name of user that use CLI.
java -jar jenkins-cli.jar -s http://localhost -ssh -user jdoe who-am-iDo not specify port in URL
Documentation : http://localhost/cli/command/disable-job
java -jar jenkins-cli.jar -s http://localhost -ssh -user jdoe disable-job guardian-frontend/masterQuiet down Jenkins, in preparation for a restart. Don’t start any builds. Documentation : http://localhost/cli/command/quiet-down
java -jar jenkins-cli.jar -s http://localhost -ssh -user jdoe quiet-down- Jenkins CLI documentation : https://www.jenkins.io/doc/book/managing/cli/
- Jenkins CLI API reference : http://localhost/cli