Commands References¶

jxctl¶

jxctl - jenkins command line tool

jxctl [OPTIONS] COMMAND [ARGS]...

context¶

Set and Get Jenkins context

jxctl context [OPTIONS] COMMAND [ARGS]...

delete¶

Delete a jenkins context

jxctl context delete [OPTIONS] CONTEXT_NAME

Arguments

CONTEXT_NAME¶: Required argument

info¶

Show the infomation about jenkins

jxctl context info [OPTIONS]

list¶

List available jenkins context

jxctl context list [OPTIONS] [CONTEXT_NAME]

Options

-a, --all¶

Arguments

CONTEXT_NAME¶: Optional argument

rename¶

Rename the jenkins context

jxctl context rename [OPTIONS] CONTEXT_FROM CONTEXT_TO

Arguments

CONTEXT_FROM¶: Required argument

CONTEXT_TO¶: Required argument

set¶

Set jenkins Context

jxctl context set [OPTIONS] CONTEXT_NAME

Options

--url <url>¶: URL of the Jenkins instance

--user <user>¶: Username of the Jenkins instance

--token, --password <token>¶: Access token / password of the username

--default¶: Set as current context

Arguments

CONTEXT_NAME¶: Required argument

set-current¶

Set the current jenkins context

jxctl context set-current [OPTIONS] CONTEXT_NAME

Arguments

CONTEXT_NAME¶: Required argument

get¶

Get the jenkins resources(jobs, plugin, nodes, etc.. ) from jenkins

jxctl get [OPTIONS] COMMAND [ARGS]...

folders¶

Get all folders from jenkins

jxctl get folders [OPTIONS]

Options

-f, --format <format>¶: Display format(json/table). Default=json

-c, --count¶: Returns the number of plugin installed

jobs¶

Get list of job from jenkins

jxctl get jobs [OPTIONS]

Options

-c, --count¶: Returns number of jobs

-a, --all¶: List all(maven,freestly, pipelinemulti-branch, matrix and org) jobs

-o, --option <option>¶: Possible Options pipeline, multi-branch, maven, freestyle, matrix, org

-f, --format <format>¶: Display format(json/table). Default=json

--help¶: Print help message

nodes¶

Get list of nodes from jenkins

jxctl get nodes [OPTIONS]

Options

-f, --format <format>¶

plugins¶

List all installed plugins from jenkins

jxctl get plugins [OPTIONS]

Options

-f, --format <format>¶: Display format(json/table). Default=json

-c, --count¶: Returns the number of plugin installed

job¶

Job info and operation

jxctl job [OPTIONS] JOB_NAME

Options

--build¶: Triggers the build

--params <params>¶: Trigger build with params in Key:Value pair

--abort <abort>¶: Abort the build

--buildinfo <buildinfo>¶: Get build info

-d, --delete¶: Delete a job

-f, --format <format>¶: Display format(json/table). Default=json

Arguments

JOB_NAME¶: Required argument

node¶

Get node info and operation

jxctl node [OPTIONS] NODE_NAME

Options

--make-offline¶

--make-online¶

-m, --message <message>¶: Offline reason

-f, --format <format>¶: Display format(json/table). Default=json

Arguments

NODE_NAME¶: Required argument

plugin¶

Get plugin information

jxctl plugin [OPTIONS] PLUGIN_NAME

Arguments

PLUGIN_NAME¶: Required argument

version¶

Show the version and info of jxctl

jxctl version [OPTIONS]