Related information
Examples
Generated documentation
The information in this section is automatically generated.
The following examples assume that the CLI specific bat or sh file has been customized for your environment. See Installation and Use.
3.3.0
Command
bamboo --action getProjectList --file "target/output/bamboocli/deleteProjects.txt" --attribute "key"
bamboo --action clonePlan --build "ZTEMPLATE-checkout1" --file "target/output/bamboocli/clonePlancheckout1.txt" --toPlan "ZBAMBOOCLI4781852-checkout1" --name "Clone of checkout1" --description "Created based on ZTEMPLATE-checkout1"
bamboo --action getPlan --plan "ZBAMBOOCLI4781852-checkout1" --verbose
bamboo --action clonePlan --build "ZTEMPLATE-checkout1" --file "target/output/bamboocli/clonePlancheckout1Disable.txt" --toPlan "ZBAMBOOCLI4781852-checkout1Disable" --disable
bamboo --action getPlan --plan "ZBAMBOOCLI4781852-checkout1Disable"
bamboo --action disablePlan --build "ZBAMBOOCLI4781852-checkout1"
bamboo --action enablePlan --build "ZBAMBOOCLI4781852-checkout1"
bamboo --action queueBuild --build "ZBAMBOOCLI4781852-checkout1" --wait
bamboo --action clonePlan --build "ZTEMPLATE-notask" --file "target/output/bamboocli/clonePlannotask.txt" --toPlan "ZBAMBOOCLI4781852-notask" --name "Clone of notask" --description "Created based on ZTEMPLATE-notask"
bamboo --action clonePlan --build "ZTEMPLATE-notask" --file "target/output/bamboocli/clonePlannotaskDisable.txt" --toPlan "ZBAMBOOCLI4781852-notaskDisable" --disable
bamboo --action disablePlan --build "ZBAMBOOCLI4781852-notask"
bamboo --action enablePlan --build "ZBAMBOOCLI4781852-notask"
bamboo --action queueBuild --build "ZBAMBOOCLI4781852-notask" --wait
bamboo --action disableProject --project "ZBAMBOOCLI4781852"
bamboo --action enableProject --project "ZBAMBOOCLI4781852"
bamboo --action addTask --build "ZBAMBOOCLI4781852-checkout1" --job "JOB1" --taskKey "com.atlassian.bamboo.plugins.scripttask:task.builder.script" --description "initial description before update" --fields "argument:aaaaa,environmentVariables:eeeee=vvvvv" --field1 "scriptLocation" --value1 "INLINE" --field2 "scriptBody" --value2 "echo 'exitCode: \$
exit \$
"
bamboo --action updateTask --build "ZBAMBOOCLI4781852-checkout1" --job "JOB1" --id "2" --description "task description" --fields "argument:aaaaa,environmentVariables:eeeee=vvvvv" --field1 "scriptLocation" --value1 "INLINE" --field2 "scriptBody" --value2 "echo 'exitCode: \$
bamboo --action addTask --build "ZBAMBOOCLI4781852-checkout1" --job "JOB1" --taskKey "com.atlassian.bamboo.plugins.scripttask:task.builder.script" --description "task description" --fields "argument:aaaaa,environmentVariables:eeeee=vvvvv" --field1 "scriptLocation" --value1 "INLINE" --field2 "scriptBody" --value2 "echo 'exitCode: \$
'
bamboo --action queueBuild --build "ZBAMBOOCLI4781852-checkout1" --wait --timeout 90 --fields "exitCode: 0" --verbose
bamboo --action verifyBuild --build "ZBAMBOOCLI4781852-checkout1"
bamboo --action renderRequest --build "ZBAMBOOCLI4781852-checkout1" --job "JOB1" --file "target/output/bamboocli/renderRequestBuildResultcheckout1.txt" --request "-2/log"
bamboo --action removeTask --build "ZBAMBOOCLI4781852-checkout1" --job "JOB1" --id "2"
bamboo --action cloneProject --project "ZTEMPLATE" --toProject "ZBAMBOOCLI4781852CLONE"
bamboo --action getPlan --project "ZBAMBOOCLI4781852CLONE" --plan "ZBAMBOOCLI4781852CLONE-CHECKOUT1"
bamboo --action cloneProject --project "ZTEMPLATE" --toProject "ZBAMBOOCLI4781852CLONEDisable" --disable
bamboo --action getPlan --plan "ZBAMBOOCLI4781852CLONE-checkout1"
bamboo --action getServerInfo
bamboo --action getBuild --file "target/output/bamboocli/getBuild.txt" --build "XXX-DEF"
bamboo --action queueBuild --build "XXX-DEF" --wait
bamboo --action getLatestBuildNumber --build "XXX-DEF"
bamboo --action getBuild --file "target/output/bamboocli/getBuildWithResultName.txt" --build "XXX-DEF-591"
bamboo --action verifyBuild --build "XXX-DEF-591"
bamboo --action getArtifact --job "JOB1" --file "target/output/bamboocli/getArtifact.txt" --build "XXX-DEF" --artifact "notices"
bamboo --action getArtifact --job "JOB1" --file "target/output/bamboocli/getArtifactWithResultName.txt" --build "XXX-DEF-591" --artifact "notices"
bamboo --action getArtifact --file "target/output/bamboocli/getArtifactWithJob.txt" --build "XXX-DEF" --artifact "notices" --job "JOB1"
bamboo --action getArtifact --file "target/output/bamboocli/getArtifactWithPath.txt" --build "XXX-DEF" --artifact "src/itest/groovy/cli.gant"
bamboo --action getProjectList --file "target/output/bamboocli/getProjectList.txt"
bamboo --action getProjectList --file "target/output/bamboocli/getProjectListAttributeName.txt" --attribute "name"
bamboo --action getProjectList --file "target/output/bamboocli/getProjectListAttributeKey.txt" --attribute "key"
bamboo --action getProjectList --file "target/output/bamboocli/getProjectListAttributeHref.txt" --attribute "href"
bamboo --action getPlanList --file "target/output/bamboocli/getPlanList.txt"
bamboo --action getPlanList --project "ZTEMPLATE" --file "target/output/bamboocli/getPlanListByProject.txt"
bamboo --action getPlanList --favourite
bamboo --action getPlanList --file "target/output/bamboocli/getPlanListAttributeHref.txt" --attribute "href"
bamboo --action getBuildList --file "target/output/bamboocli/getBuildList.txt"
bamboo --action getBuildList --file "target/output/bamboocli/getBuildListByProject.txt" --project "ZBAMBOOCLI4781852"
bamboo --action getBuildList --favourite
bamboo --action addLabels --build "XXX-DEF" --number -1 --labels "testlabel1 testlabel2"
bamboo --action getBuildList --attribute "key" --labels "testlabel1,testlabel2"
bamboo --action getBuildList --attribute "href" --labels "testlabel1,testlabel2"
bamboo --action getBuildList --file "target/output/bamboocli/getBuildListSearchDetail.txt" --labels "testlabel1,testlabel2"
bamboo --action getBuildList --build "XXX-DEF" --attribute "key" --labels "testlabel1,testlabel2"
bamboo --action getBuildList --build "YYY-DEF" --attribute "key" --labels "testlabel1,testlabel2"
bamboo --action getBuildList --project "XXX" --attribute "href" --labels "testlabel1,testlabel2"
bamboo --action getBuildQueueList
bamboo --action getBuildQueueList --project "ZBAMBOOCLI4781852"
bamboo --action getBuildQueueList --build "XXX-DEF"
bamboo --action addComment --build "XXX-DEF" --comment "This is a comment added by automation"
bamboo --action addComment --build "XXX-DEF" --number "591" --file "src/itest/resources/data.txt" --findReplace "xxx:yyy"
bamboo --action getCommentList --build "XXX-DEF" --number "591"
bamboo --action removeLabels --build "XXX-DEF" --number -1 --labels "notfound"
bamboo --action getLabelList --build "XXX-DEF" --number -1
bamboo --action removeLabels --build "XXX-DEF" --number -1 --labels ".*"
bamboo --action removeLabels --build "XXX-DEF" --number -1 --labels "testlabel1, testlabel2, notfound"
bamboo --action addLabels --labels "morelabel1" --searchLabels "testlabel1 testlabel2"
bamboo --action removeLabels --labels "morelabel1" --searchLabels "testlabel1,testlabel2"
bamboo --action addLabels --build "XXX-DEF" --labels "testlabel1, testlabel2"
bamboo --action removeLabels --build "XXX-DEF" --labels "test.*"
bamboo --action run --file "src/itest/resources/run.txt"
bamboo --action run < src/itest/resources/run.txt
bamboo --action run
bamboo --action runFromSql --file "src/itest/resources/run.sql" --host "imac.local" --driver "postgresql" --database "test"
bamboo --action runFromList --list "Client, Server" --common "-a get<at:var at:name="entry" />Info"
bamboo --action renderRequest --build "XXX-DEF" --file "target/output/bamboocli/renderRequestBuild.txt"
bamboo --action renderRequest --build "XXX-DEF" --job "JOB1" --file "target/output/bamboocli/renderRequestJob.txt"
bamboo --action renderRequest --build "XXX-DEF" --job "JOB1" --file "target/output/bamboocli/renderRequestConfig.txt" --request "/config"
bamboo --action renderRequest --file "target/output/bamboocli/renderRequestConfig2.txt" --request "/browse/XXX-DEF-JOB1/config"
bamboo --action run --file "src/itest/resources/renderRequest.txt" --findReplace "<at:var at:name="build" />:XXX-DEF"
bamboo --action deletePlan --build "ZBAMBOOCLI4781852-notask"