Jenkins Command Line大全[翻譯]

時間 2019-11-11

原文原文鏈接

通用格式

 java -jar jenkins-cli.jar [-s JENKINS_URL] command [options...] [arguments...]

JENKINS_URL範例：http://192.168.14.56:8080/jenkins/

add-job-to-viewjava

將一個任務加入視圖中node

java -jarjenkins-cli.jar -s http://192.168.14.56:8080/jenkins/ add-job-to-view VIEW JOB...shell

VIEW:視圖名稱安全

JOB:job名稱服務器

buildsession

啓動build，能夠選擇是否等待一個工做的完成。除了通用的腳本使用以外，該命令能夠被用於在一個job的構建中調用另外一個job。使用–s 選項，該命令更改構建輸出和中斷命令而且會中斷job的返回碼（返回0表示成功）。使用–f 選項，該命令更改基於輸出構建的返回碼（返回0表示成功）。可是，跟-s選項不同，中斷命令行不會中斷job。（返回碼125表示該命令被中斷）。使用–c 選項，命令僅在SCM(源代碼管理系統)發生改變時執行build。工具

java -jarjenkins-cli.jar -s http://192.168.14.56:8080/jenkins/ build JOB [-c] [-f] [-p][-r N] [-s] [-v] [-w]ui

JOB:要構建的Job名稱this

-c:在構建前檢查SCM更改，若是代碼沒有改動則不執行構建。spa

-f:跟隨構建過程，與-s類似，中斷不會傳給構建。

-p:指定構建參數以key=value形式傳入

-s:等待直到命令完成或中斷。中斷會傳給構建。

-v:打印控構建的制臺輸出。使用-s

-w:等待直到命令開始。

cancel-quiet-down

消除「quiet-down」命令的影響。

java-jar jenkins-cli.jar -s http://192.168.14.56:8080/jenkins/ cancel-quiet-down

clear-queue

清除構建隊列

java-jar jenkins-cli.jar -s http://192.168.14.56:8080/jenkins/ clear-queue

connect-node

java-jar jenkins-cli.jar -s http://192.168.14.56:8080/jenkins/ connect-node NAME[-f]

從新鏈接至一個節點（jenkins主從節點）

NAME:從節點名稱，空表示master節點

-f:取消全部當前正在等待的鏈接操做，並重試。

console

java-jar jenkins-cli.jar -s http://192.168.14.56:8080/jenkins/ console JOB [BUILD][-f] [-n N]

處理指定構建的標準控制檯輸出，就好像在使用’cat build.log’命令同樣。

JOB:job的名稱

BUILD:構建號或者指向構建的固定鏈接。默認指向最後一個構建。

-f:若是構建正在執行，停住並追加控制檯輸出，就好像在使用’tail -f’命令同樣。

-nN:顯示最後N行。

copy-job

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ copy-job SRC DST

複製job

SRC:待拷貝的job

DST:新的待建立的job

create-job

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ create-job NAME

經過從標準輸入中讀取一個xml配置文件來建立job

NAME:job的名稱

create-node

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ create-node [NODE]

經過從標準輸入中讀取一個xml配置文件來建立新節點。

NODE:節點名

create-view

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ create-view [VAL]

經過從標準輸入中讀取一個xml配置文件來建立新視圖。

VAL:要使用的視圖稱名而不是在XML中的視圖名稱。

delete-builds

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ delete-builds JOB RANGE

刪除指定job的構建記錄，能夠是批量的。

JOB:job名稱。

RANGE:要刪除的構建的範圍。」N-M」,」N,M」或者」N」。

delete-job

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ delete-job VAL ...

刪除job

VAL:要刪除的job(s)名稱。

delete-node

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ delete-node VAL ...

刪除節點

VAL:要刪除的節點(s)

delete-view

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ delete-view VAL ...

刪除視圖

VAL:要刪除的視圖名稱

disable-job

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ disable-job NAME

禁用job

NAME:job名稱

disconnect-node

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ disconnect-node NAME [-m VAL]

斷開節點的鏈接

NAME:從節點名稱，空字串表示master節點

-mVAL:記錄你爲何斷開這個節點的筆記。

enable-job

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ enable-job NAME

啓用Job

NAME:job名稱

get-job

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ get-job JOB

轉儲job的XML定義到標準輸出。

JOB:job的名稱

get –node

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ get-job JOB

轉儲節點的XML定義到標準輸出。

NODE:節點的名稱。

get-view

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ get-view VIEW

轉儲視圖的XML定義到標準輸出

VIEW:要獲取的視圖名稱

groovy

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ groovy [SCRIPT] [ARGUMENTS ...]

執行指定的Groovy腳本

SCRIPT:要執行的腳本文件，URL或者=表明標準輸入。

ARGUMENTS:傳入腳本的命令行參數。

groovysh

java -jar jenkins-cli.jar -s http://192.168.14.56:8080/jenkins/groovysh [ARGS ...]

執行交互的groovyshell

install-plugin

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ install-plugin SOURCE ... [-deploy] [-nameVAL] [-restart]

從文件，URL或者updatecenter安裝插件

SOURCE:若是參數指向一個本地文件，該文件會被安裝。若是是URL，jenkins下載該URL並安裝插件。不然，這個名字會被認爲是現有的update center中的插件的簡寫（例如:」findbugs」），這個插件會被從update center安裝。

-deploy:馬上部署該插件而不是推遲到重啓jenkins.

-nameVAL:若是指定該參數，插件會被以這麼簡寫的名字安裝。（然而一般插件的名字是從原文件名中自動推斷出來的）。

-restart插件安裝成功以後重啓jenkins

install-tool

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ install-tool [KIND] [NAME]

執行自動化的工具安裝，而且在標準輸出中打印他的安裝位置。只能在一個構建裏面調用。

KIND:要安裝的工具類型，例如」Ant」

NAME:要安裝的工具名稱，正如你已經進入了jenkins的系統配置頁面。

keep-build

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ keep-build NAME BUILD#+

標記這個構建以保證該構建永遠運行。

NAME:job名字

BUILD#:構建序號

list-changes:

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ list-changes JOB RANGE [-format [XML| CSV | PLAIN]]

轉儲指定構建的changelog

JOB:要構建的job名字

RANGE:要轉儲的構建範圍，N-M,N,M或者N

-format[XML |CSV | PLAIN] :控制如何輸出該命令的結果。

list-jobs:

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ list-jobs [NAME]

列出指定視圖或者項目組的全部的jobs

NAME:視圖名字

list-plugins

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ list-plugins [NAME]

列出已安裝的插件

NAME:指定插件名

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ login

保存當前的憑據，之後的命令再也不須要明確的登陸憑據。

logout

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ logout

刪除登陸命令中存儲的憑據。

mail

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ mail

從標準輸出中讀取並以e-mail的方式發送。

offline-node

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ offline-node NAME [-m VAL]

臨時中止節點，直至遇到下一個online-node命令

NAME:從節點名字，空字串表示master

-mVAL:記錄爲何斷開這個節點

online-node

java -jar jenkins-cli.jar -s http://192.168.14.56:8080/jenkins/online-node [NAME]

恢復節點的使用。

NAME:從節點名字，空字串表示master

quiet-down

java -jar jenkins-cli.jar -s http://192.168.14.56:8080/jenkins/quiet-down [-block] [-timeout N]

使jenkins進入平息狀態，爲重啓作準備。千萬不要在此期間構建任何項目。

-block:阻塞（該命令）直至系統真的平息下來並且沒有項目在構建。

-timeoutN: 若是非0，只阻塞指定的毫秒數。

reload-configuration

java -jar jenkins-cli.jar -s http://192.168.14.56:8080/jenkins/reload-configuration

丟棄全部內存中已加載的數據並從文件系統中從新加載。在你修改了磁盤配置文件時這條命令會有用。

reload-job

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ reload-job VAL ...

從新加載job(s)

VAL:要從新加載的job名稱

remove-job-from-view

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ remove-job-from-view VIEW JOB ...

從指定視圖中刪除job

VIEW:視圖的名稱

JOB:job名

restart

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ restart

重啓jenkins

safe-restart

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ safe-restart

安全重啓jenkins

safe-shutdown

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ safe-shutdown

將jenkins置爲安靜模式，等待現執行的構建完成。而後中止jenkins.

session-id

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ session-id

輸出session ID,每次jekins重啓以後的sessionID都不一樣。

set-build-description

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ set-build-description JOB BUILD# DESCRIPTION

設置一個構建的描述

JOB:BUILD

DESCRIPTION:要設置的描述，=從標準輸入加載

set-build-display-name

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ set-build-display-name JOB BUILD#DISPLAYNAME

設置構建的展現名稱。

JOB,BUILD#,

DISPLAYNAME:要設置的展現名。-從標準輸入加載

set-build-parameter

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ set-build-parameter NAME VALUE

更改、設置當前正在處理的構建的構建參數。

NAME:構建變量名

VALUE:構建變量值

set -build-result+

java -jar jenkins-cli.jar -s http://192.168.14.56:8080/jenkins/set-build-result RESULT

設置當前構建的結果。只能在一個構建以內調用。

set-external-build-result

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ set-external-build-result [--display (-n) DISPLAY][--dump-build-number (-b)] [--duration (-d) DURATION] --job (-j) JOB --log (-l)-|LOG [--result (-r) RESULT]

設置額外的管理job結果

--display(-n) DISPLAY : Display name of thebuild

--dump-build-number (-b) :Log the produced build number to the standard output

--duration (-d) DURATION :Number of milli-seconds it took to run this build

--job (-j) JOB : Name of the external monitor job

--log (-l) -|LOG : Log to be set. '-' to read fromstdin (gzipped).

--result (-r) RESULT : 0: success, 1: fail

shutdown

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ shutdown

當即關閉jekins服務器。

update-job

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ update-job JOB