User Guide¶

Installation¶

Install the package (or add it to your requirements.txt file):

pip install jxctl

Configuration¶

Add new context¶

jxctl context set <CONTEXT_NAME> --url <Jenkins URL> --user <Username> --token <Password/Access Token>
jxctl context set <CONTEXT_NAME> --url <Jenkins URL> --user <Username> --token <Password/Access Token> --default

Context Info¶

jxctl context info

List context¶

jxctl context list
jxctl context list --all

Update context¶

jxctl context set <CONTEXT_NAME> --url <Jenkins URL>
jxctl context set <CONTEXT_NAME> --user <Username> --token <Password/Access Token>

Rename context¶

jxctl context rename <CONTEXT_FROM> <CONTEXT_TO>

Delete context¶

jxctl context delete <CONTEXT_NAME>

Usage¶

Version¶

jxctl version

Jobs List¶

jxctl get jobs --all -f table
jxctl get jobs -o maven -o freestyle --count -f json
jxctl get jobs --option pipeline -c

Folders List¶

jxctl get folders -f table
jxctl get folders -c

Plugins List¶

jxctl get pluings
jxctl get pluings -c

Nodes List¶

jxctl get nodes
jxctl get nodes -c -f table

Job¶

Job info¶

jxctl job <JOB NAME>
jxctl job <JOB NAME> --format table

Delete a job¶

jxctl job <JOB NAME> --delete

Trigger job build¶

jxctl job <JOB NAME> --build
jxctl job <JOB NAME> --build --params <JSON>

Build info¶

jxctl job <JOB NAME> --buildinfo <Build Number>

Abort a build¶

jxctl job <JOB NAME> --abort <Build Number>

Plugin¶

jxctl plugin <Plugin Name>

Node¶

Node info¶

jxctl node <NODE NAME>
jxctl node <NODE NAME> -f table

Make offline¶

jxctl node <NODE NAME> --make-offline
jxctl node <NODE NAME> --make-offline -m <MESSAGE>

Make online¶

jxctl node <NODE NAME> --make-online