Command-line utility for downloading Jenkins job console logs
Project description
download-jenkins-build-log utility
This is a simple tool that enables downloading console output files from Jenkins jobs. Freestyle, pipeline and matrix jobs are supported.
Pre-requisites
Python 3.3 or later
Installation
pip3 install download-jenkins-build-log
Basic Usage
Use
download-jenkins-build-log -h
to see all the available options.
For example, to download the console log of a freestyle project my-freestyle-job
with the build number 123
into the target directory of logs
from the Jenkins
instance at https://myjenkins.example.com:8080
, use the following command line:
download-jenkins-build-log --url https://myjenkins.example.com:8080 --build 123 --directory logs my-freestyle-job
Authentication
You may use the --login
to set the user name and the --token
to set
the password or API token to access Jenkins. Jenkins documentation recommends
creating an API token
to use with tools.
Alternatively, you can also provide credentials with the following environment variables.
Environment variable name | Description |
---|---|
DOWNLOAD_JENKINS_BUILD_LOG_LOGIN |
login name |
DOWNLOAD_JENKINS_BUILD_LOG_API_TOKEN |
password or API token |
Return Codes
The tool will return 0
in case of successful execution, and -1
in case of an error.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for download-jenkins-build-log-0.0.1a7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1550399f8e74534696717f9ea1f087cd6b6e81c428698ecd74bcdaa1460b36de |
|
MD5 | 70b83f53b05df0d547b4599854ef9214 |
|
BLAKE2b-256 | 1fb5fe49c704737e2c13103313c777fbaabc44893c67b917d1e4e2b0ccda91ab |
Hashes for download_jenkins_build_log-0.0.1a7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 05358383a374181ef1e6aa8ea9bf195651c0030b57079a55ffe858fb0518e705 |
|
MD5 | 02326e08dd0d6871f5c5a87bca842160 |
|
BLAKE2b-256 | 13d70b576fb2832bf871408b92b68d56966d174de613d1388cb24244cca53c38 |