Usage:
bamboo (-a|--action) <action> [(-f|--file) <file>] [--encoding <encoding>] [--debug] [-v|--verbose] [--quiet] [--outputFormat
<outputFormat>] [--columns <columns>] [--connectionTimeout <connectionTimeout>] [--sql <sql>] [--driver <driver>] [--url <url>]
[--host <host>] [--port <port>] [--database <database>] [--dbUser <dbUser>] [--dbPassword <dbPassword>] [--propertyFile
<propertyFile>] [--common <common>] [--special <special>] [--dateFormat <dateFormat>] [--findReplace <findReplace>]
[--findReplaceRegex <findReplaceRegex>] [--list <list>] [--continue] [--simulate] [--append] [--clearFileBeforeAppend] (-s|--server)
<server> (-u|--user) <user> (-p|--password) <password> [--service <service>] [--api <api>] [--cookies <cookies>] [--project
<project>] [--toProject <toProject>] [--projectName <projectName>] [--build <build>] [--plan <plan>] [--toPlan <toPlan>] [--stage
<stage>] [--job <job>] [--name <name>] [--description <description>] [--agent <agent>] [--assignment <assignment>] [--artifact
<artifact>] [--requirement <requirement>] [--type <type>] [--value <value>] [--labels <labels>] [--searchLabels <searchLabels>]
[--issues <issues>] [--expand <expand>] [--attribute <attribute>] [--comment <comment>] [--revision <revision>] [--location
<location>] [--copyPattern <copyPattern>] [--repository <repository>] [--after <after>] [--schedule <schedule>] [--taskKey
<taskKey>] [--repositoryKey <repositoryKey>] [--event <event>] [--recipientType <recipientType>] [--fields <fields>]
[--ipRestriction <ipRestriction>] [--field1 <field1>] [--field2 <field2>] [--field3 <field3>] [--field4 <field4>] [--field5
<field5>] [--field6 <field6>] [--value1 <value1>] [--value2 <value2>] [--value3 <value3>] [--value4 <value4>] [--value5 <value5>]
[--value6 <value6>] [--regex <regex>] [--request <request>] [--requestParameters <requestParameters>] [--requestType <requestType>]
[--acceptType <acceptType>] [--id <id>] [--number <number>] [--timeout <timeout>] [--limit <limit>] [--wait] [--favourite]
[--favorite] [--replace] [--enable] [--disable] [--manual] [--shared] [--cleanAfter] [--help]
Provides capability to make requests to a remote server.
Required parameters: action, server, password.
Optional parameters: user (likely required for your installation).
Other required and optional parameters depending on action requested.
(-a|--action) <action>
Requested operation to perform. Valid actions are listed at the end.
[(-f|--file) <file>]
Path to file based content or result output. Use - for standard input.
[--encoding <encoding>]
Character encoding (character set) for text based file content - must be an encoding supported by your JAVA platform.
[--debug]
Requests detail debug output. Optional for all actions.
[-v|--verbose]
Requests verbose output to help with problem determination. Optional for all actions.
[--quiet]
Limit some output messages. Optional for all actions.
[--outputFormat <outputFormat>]
Specify output format for an action. (default: 1)
[--columns <columns>]
Column selection and ordering when action generates CSV output. A comma separated list of column numbers (1-based) or column
names (case insensitive). Only columns provided by the selected outputFormat are available for selection. Invalid columns
will be ignored.
[--connectionTimeout <connectionTimeout>]
Allow overriding environment settings for connect and read timeouts on URL connections. In milliseconds, 0 means infinite.
[--sql <sql>]
SQL select statement used to generate a run script.
[--driver <driver>]
JDBC driver class or predefined value: postgresql, mysql, mssql, oracle, or db2400. Required for SQL actions.
[--url <url>]
Action specific setting. Example: Database access url for SQL actions. Optional when host is provided.
[--host <host>]
Database host server for SQL actions. Not used if url is provided. (default: localhost)
[--port <port>]
Database host port for SQL actions. Optional, defaults to database default. Not used if url is provided.
[--database <database>]
Database name is required for SQL actions.
[--dbUser <dbUser>]
Database user name. Defaults to user.
[--dbPassword <dbPassword>]
Database user password. Defaults to password.
[--propertyFile <propertyFile>]
Property file with mapping information.
[--common <common>]
Common parameter string added to all run actions.
[--special <special>]
Ordered list of alternate characters for comma ( , ), colon ( : ), at ( @ ), quote ( ' ), and double quote ( " ) characters
used for specialized processing of some specific parameters.
[--dateFormat <dateFormat>]
Format string for date in Java SimpleDateFormat, default is client date format.
[--findReplace <findReplace>]
Find and replace text. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded
quotes must be doubled.
[--findReplaceRegex <findReplaceRegex>]
Find and replace text with a regular expression. Comma separated list of colon separated pairs. Single quote values
containing a delimiter. Embedded quotes must be doubled.
[--list <list>]
Comma separated list of entries. Single quote values containing a delimiter. Embedded quotes must be doubled.
[--continue]
Continue processing even after errors are encountered for run actions. Also used for some action to ignore certain errors
like not found errors on remove actions.
[--simulate]
Simulate running actions. Log the action that would be taken.
[--append]
For some actions using the file parameter, append will append output to the existing file.
[--clearFileBeforeAppend]
For run actions, this option will automatically clear an existing file on the first append requested.
(-s|--server) <server>
Server URL. Normally the base URL of the server and the same as how the server is accessed from a browser.
(-u|--user) <user>
User name for remote access. (default: automation)
(-p|--password) <password>
User password for remote access.
[--service <service>]
Service address extension. (default: /rest/api)
[--api <api>]
API version. Some requests produce different results based on the api version used. (default: latest)
[--cookies <cookies>]
Name of file to restore and persist cookies across invocations of CLI actions. Can be used to provide Data Center session
affinity for actions using REST APIs.
[--project <project>]
Project key. Example: XXX
[--toProject <toProject>]
Project key to clone to.
[--projectName <projectName>]
Project name.
[--build <build>]
Build key. Normally used to refer to a specific build (3 part name). However, it was also an older terminology for a plan
and some action continue to accept the older terminology. Example: XXX-DEF or XXX-DEF-1
[--plan <plan>]
Plan key containing the project key. Preferred way to reference a plan instead of the older build terminology. Example:
XXX-DEF
[--toPlan <toPlan>]
Plan key to be created. Example: XXX-DEF
[--stage <stage>]
Stage name.
[--job <job>]
Job key. Example: JOB1
[--name <name>]
Name of entity, like plan name.
[--description <description>]
Description for entity.
[--agent <agent>]
Agent name.
[--assignment <assignment>]
Key used to identify a project, plan, or job to be assigned to a specific agent. This makes the agent dedicated to only
perform builds for all assignments. Example: XXX, XXX-DEF, XXX-DEF-JOB1
[--artifact <artifact>]
Build artifact name. May be extended by a path name for locating files within an artifact representing a dirctory.
[--requirement <requirement>]
Plan requirement key, either a custom key or a system capability key like: system.builder.ant.Ant.
[--type <type>]
Requirement match type. Values: exist, equal, match. Also, content type for renderRequest. (default: exist)
[--value <value>]
Requirement match value.
[--labels <labels>]
Comma or blank separated list of labels.
[--searchLabels <searchLabels>]
Comma or blank separated list of labels used for search.
[--issues <issues>]
Comma separated list of JIRA issue keys.
[--expand <expand>]
Expanded request information to obtain more detailed data on request.
[--attribute <attribute>]
Attribute to list.
[--comment <comment>]
Comment for an build.
[--revision <revision>]
Revision id or tag.
[--location <location>]
Working directory relative path to a source location for an artifact definition or a destination location for an artifact
dependency.
[--copyPattern <copyPattern>]
Copy pattern for an artifact definition.
[--repository <repository>]
Name of a repository. In some cases, a comma separated list of repository names.
[--after <after>]
Used in orderRepository to name the repository after which the repository will be positioned.
[--schedule <schedule>]
Cron, daily time, or periodic schedule. A cron schedule must be valid cron expresssions and defaults to 0 0 0 ? * *. A daily
time is a 24 hour format (HH:mm) value. A periodic schedule is a numeric value in seconds and defaults to 180.
[--taskKey <taskKey>]
Task key. Example: com.atlassian.bamboo.plugins.scripttask:task.builder.script
[--repositoryKey <repositoryKey>]
Repository key that uniquely identifies the repository type. Example:
com.atlassian.bamboo.plugins.atlassian-bamboo-plugin-mercurial:hg
[--event <event>]
Event alias or key. Add-ons provide events identified by key. Example key:
com.atlassian.bamboo.plugin.system.notifications:chainCompleted.failedChains
[--recipientType <recipientType>]
Recipient type alias or key. Add-ons provide recipient types identified by key. Example key:
com.atlassian.bamboo.plugins.bamboo-hipchat:recipient.hipchat
[--fields <fields>]
Use to specify task or repository specific fields or variables and their values. A comma separated list of key:value pairs.
Single quote the key:value pair if it contains a comma (,) or line breaks.
[--ipRestriction <ipRestriction>]
Comma separated list of IP addresses to restrict ability to remotely trigger builds.
[--field1 <field1>]
Task or repository specific field or variable name. Value is specified by the value1 parameter.
[--field2 <field2>]
Task or repository specific field or variable name. Value is specified by the value2 parameter.
[--field3 <field3>]
Task or repository specific field or variable name. Value is specified by the value3 parameter.
[--field4 <field4>]
Task or repository specific field or variable name. Value is specified by the value4 parameter.
[--field5 <field5>]
Task or repository specific field or variable name. Value is specified by the value5 parameter.
[--field6 <field6>]
Task or repository specific field or variable name. Value is specified by the value6 parameter.
[--value1 <value1>]
Value corresponding to the field1 parameter name.
[--value2 <value2>]
Value corresponding to the field2 parameter name.
[--value3 <value3>]
Value corresponding to the field3 parameter name.
[--value4 <value4>]
Value corresponding to the field4 parameter name.
[--value5 <value5>]
Value corresponding to the field5 parameter name.
[--value6 <value6>]
Value corresponding to the field6 parameter name.
[--regex <regex>]
Regular expression for list filtering and similar. Also for pattern match labelling.
[--request <request>]
URL fragment for a request.
[--requestParameters <requestParameters>]
URL request parameters
[--requestType <requestType>]
Type of a render request like GET or POST (default: GET)
[--acceptType <acceptType>]
Content type to accept for renderRequest if different than type.
[--id <id>]
Stage or task id.
[--number <number>]
Build number. Defaults to latest. (default: 0)
[--timeout <timeout>]
Wait timeout in seconds. Use -1 to wait forever. (default: -1)
[--limit <limit>]
Maximum number of entries to return. (default: 2147483647)
[--wait]
Wait for action to complete.
[--favourite]
Subset to favourites. Same as favorite.
[--favorite]
Subset to favorites. Same as favourite.
[--replace]
Replace existing entity.
[--enable]
Enable an entity when updating.
[--disable]
Disable an entity for those entities like plans, stages, jobs, and tasks.
[--manual]
Indicate that a stage be run manually.
[--shared]
For an artifact definition, makes the artifact available for other builds.
[--cleanAfter]
Clean working directory after each job completes. Use on setJobOptions.
[--help]
Prints this help message.
Valid actions (case insensitive):
run - Run actions from a file or standard input.
Required parameters: file or standard input
Optional parameters: common, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex
runFromSql - Run actions generated by SQL provided by the sql parameter, a file, or standard input
Required parameters: sql or file or standard input
Optional parameters: common, driver, database, host, port, url, dbUser, dbPassword,
propertyFile, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex
runFromCsv - Run actions generated from a CSV file.
Required parameters: file
Optional parameters: common, propertyFile, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex
runFromList - Run actions for each entry in a list.
When file is provided, each action in the file augmented by the common parameter will be run for each entry.
Otherwise, just the action specified by the common parameter will be run.
Available replacement variable is entry.
Required parameters: list
Optional parameters: file, common, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex
getClientInfo - Get information about the this client tool.
Optional parameters: outputFormat, file, append, encoding
Output formats: 1 - basic, 2 - JVM
getServerInfo - Get information about the Bamboo server.
Optional parameters: outputFormat, dateFormat, file, append, encoding
Output formats: 1 - basic, 2 - detail
validateLicense - Validates the CLI Connector is enabled and licensed on the server.
renderRequest - Render url based request. The response data modified by findReplace processing is returned.
Required parameters: request
Optional parameters: requestParameters, requestType, type, acceptType, build, file, encoding, findReplace, findReplaceRegex
runFromProjectList - Run actions for each project with regex filtering on project key or name. Available replacement variables are project and projectName.
Optional parameters: regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex
runFromPlanList - Run actions for each plan with regex filtering on plan key or name. Use @all for project to get a list of plans across all projects. Available replacement variables are project, projectName, plan, and planName.
Required parameters: project
Optional parameters: favorite, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex
runFromStageList - Run actions for each stage with regex filtering on stage name. Available replacement variables are project, projectName, plan, planName, stageId, and stageName.
Required parameters: plan
Optional parameters: stage, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex
runFromJobList - Run actions for each job with regex filtering on job key or name. Restrict to a specific stage or leave stage blank to get jobs across all stages. Available replacement variables are project, projectName, plan, planName, stageId, stageName, job, and jobName.
Required parameters: plan
Optional parameters: stage, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex
runFromRepositoryList - Run actions for each repository with regex filtering on repository name. Available replacement variables are repository and repositoryId.
Optional parameters: plan, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex
runFromAgentList - Run actions for each agent with regex filtering on agent name. Available replacement variables are agent and agentId.
Optional parameters: regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex
getProjectList - Get a list of projects. Projects are selected based on regex filtering on project key or name. Legacy list support is deprecated and will be removed in the near future.
Optional parameters: regex, file, append, encoding, columns
getPlanList - Get a list of plans for a project with regex filtering on plan key or name. Use @all for project to get a list of plans across all projects.
Required parameters: project
Optional parameters: favorite, regex, columns, file, append, encoding
getRepositoryList - Get a list of global or plan repositories with regex filtering on repository name.
Optional parameters: plan, regex, file, append, encoding
getNotificationList - EAP (subject to change). Get a list of plan notifications.
Optional parameters: plan, file, append, encoding
getVariableList - Get a list of global or plan variables based on regex filtering of variable names.
Optional parameters: plan, regex, file, append, encoding
getBuildList - Get a list of builds. Default limit is 25.
Required parameters: plan
Optional parameters: limit, favorite, labels, issues, columns, file, append, encoding
Output formats: 1 - basic, 2 - test information
getBuildQueueList - Get a list of builds waiting in the build queue. Subset by project or build.
Optional parameters: project, build, file, append, encoding, columns
getLabelList - Get a list of labels for a build.
Required parameters: build
Optional parameters: number, file, append, encoding, columns
getCommentList - Get a list of comments for a build.
Required parameters: build
Optional parameters: number, file, append, encoding, columns
getStageList - Get a list of stages for a plan with regex filtering on stage name.
Required parameters: plan
Optional parameters: regex, file, attribute, columns
getJobList - Get a list of jobs for a plan with regex filtering on job key or name. Subset by stage if desired.
Required parameters: plan
Optional parameters: stage, regex, file, attribute, columns
getAgentList - Get a list of agents based on regex filtering of agent names..
Optional parameters: regex, file, append, encoding, columns
Output formats: 1 - basic, 2 - detail
queueBuild - Queue a build to run. If wait is specified, the action will not complete until the queued build completes or the timeout period elapses. The action will fail if the build fails unless continue parameter is used to ignore a failed result. A specific revision can be built if the revision parameter is specified. Plan variables can be set using the field and value parameters.
Required parameters: plan
Optional parameters: revision, wait, continue, timeout, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6
addComment - Add a comment to a build.
Required parameters: build, comment
Optional parameters: number, findReplace, findReplaceRegex, file, encoding
addLabels - Add a comma separated list of labels to a build.
Required parameters: build, labels
Optional parameters: number
removeLabels - Remove labels from a build. Labels can be a comma separated list or regex. Either build or search terms (searchLabels, issues) must be provided
Required parameters: labels
Optional parameters: build, number, searchLabels, issues, favorite
deleteProject - Delete project and all project plans.
Required parameters: project
Optional parameters: file
enableProject - Enable all project plans.
Required parameters: project
disableProject - Disable all project plans.
Required parameters: project
cloneProject - Clone each plan in a project to another project. If toProject is not provided, the plans will be cloned to the same project. If the toProject does not exist, it will be created with name provided by projectName.
Required parameters: project, toProject, projectName, disable
createPlan - Create a new plan. Provide a 2-part plan key where the first part is the project key. If the project key does not exist, it will be created with the provided project name. Server instances only.
Required parameters: plan
Optional parameters: name, projectName, description, disable
getPlan - Get plan information.
Required parameters: plan
clonePlan - Clone a plan.
Required parameters: plan, toPlan, name
Optional parameters: description, projectName, disable
deletePlan - Delete a plan.
Required parameters: plan
enablePlan - Enable a plan to run.
Required parameters: plan
disablePlan - Disable a plan from running.
Required parameters: plan
addStage - Add a stage to a plan.
Required parameters: plan, stage
Optional parameters: description, manual, disable
removeStage - Remove a stage from a plan. Use id = -1 to remove all stages. Use continue to ignore not found errors.
Required parameters: plan, stage or id
Optional parameters: continue
addJob - Add a job to a stage.
Required parameters: plan, stage, job
Optional parameters: name, description, disable
enableJob - Enable a job to run.
Required parameters: plan, job
disableJob - Disable a job from running.
Required parameters: plan, job
setJobOptions - Set miscellaneous option for a job. The following options are specifically supported: clean working directory after job completes (cleanAfter switch) and pattern matching labeling (regex and labels parameters). Use the field and value parameters for additional settings with values determined from the screen. Some previous settings may be lost if not specifically requested.
Required parameters: plan, job
Optional parameters: cleanAfter, regex, labels
getArtifact - Download a copy of a build artifact into a file.
Required parameters: build, artifact, file
Optional parameters: number
getBuild - Get build result.
Required parameters: build
Optional parameters: number, expand, file
verifyBuild - Verify build was successful.
Required parameters: build
Optional parameters: number
getLatestBuildNumber - Get the number of the last completed build for this plan.
Required parameters: plan
addArtifact - Add an artifact definition to a job. Server instances only.
Required parameters: plan, job, artifact, copyPattern
Optional parameters: location, shared
removeArtifact - Remove an artifact definition from a job. Server instances only.
Required parameters: plan, job, artifact
addArtifactDependency - Add an artifact dependency a job. Artifact must be a shared artifact from another job.
Required parameters: plan, job, artifact, location
addTask - Add a task to a plan job. A valid task key or alias is required. Valid aliases are: ANT, CHECKOUT, CLI_BAMBOO, CLI_CONFLUENCE, CLI_CRUCIBLE, CLI_FISHEYE, CLI_HIPCHAT, CLI_JIRA, CLI_STASH, GANT, GINT, GRADLE, GRADLEW, GROOVY, MAVEN2, MAVEN3, SCRIPT
Required parameters: plan, job, taskKey
Optional parameters: disable, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6
updateTask - Update a task in a plan job. You must provide the same parameters as if you were creating the task.
Required parameters: plan, job, id
Optional parameters: enable, disable, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6
removeTask - Remove a task from a plan job. Use id = -1 to remove all tasks.
Required parameters: plan, job, id
addRepository - Add a global or plan repository. For a plan repository, you can reference a linked (global) repository. Otherwise a valid repository key or alias is required. Valid aliases are: BITBUCKET, CVS, GIT, GITHUB, MERCURIAL, PERFORCE, STASH, SUBVERSION
Required parameters: repository or name
Optional parameters: plan, repositoryKey, replace, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6
updateRepository - Update a global or plan repository.
Required parameters: repository or id
Optional parameters: plan, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6
removeRepository - Remove global or plan repository. Use @all to remove all repositories.
Required parameters: repository or id
Optional parameters: plan, continue
getRepository - Get details of a global or plan repository. Sets the repository and repositoryId replacement variables.
Required parameters: repository
Optional parameters: plan
orderRepository - Order repository in the list of repositories for a plan. Defaults to move the repository to the top to make it the default repository. Otherwise specify the after respository name.
Required parameters: plan, repository
Optional parameters: after
addRequirement - Add requirement to a plan job.
Required parameters: plan, job, requirement
Optional parameters: type, value
updateRequirement - Update a plan requirement.
Required parameters: plan, job, id
Optional parameters: type, value
removeRequirement - Remove a plan requirement.
Required parameters: plan, job, id
addNotification - Add a plan notification. There are 2 parts to a notification - an event that triggers the notification and a recipient type that determines the notification protocol. There are built-in notifications and others provided by add-ons. A recipient type may have additional parameters. Generally, these can be specified by the field and values parameters. In some cases, pre-defined parameters are available.
Required parameters: plan, event, recipientType
Optional parameters: fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6
removeNotification - Remove a plan notification. Use id of -1 to remove all notifications for a plan.
Required parameters: plan, id
addVariables - Add global or plan variables.
Optional parameters: plan, replace fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6
updateVariables - Update existing global or plan variables
Optional parameters: plan fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6
removeVariables - Remove global or plan variables
Optional parameters: plan, fields, field1, field2, field3, field4, field5, field6
addTrigger - Add a trigger to a plan. Valid types are: polling, remote, scheduled. One or more repositories can be specified for triggers based on repositories. See the schedule parameter for accepted values. Server instances only.
Required parameters: plan, name, type
Optional parameters: repository, schedule, ipRestriction
removeTrigger - Remove a trigger from a plan. Use id = -1 to remove all triggers. Server instances only.
Required parameters: plan, id
addAgent - Add a local agent.
Required parameters: agent
Optional parameters: description
removeAgent - Remove an agent.
Required parameters: agent
enableAgent - Enable an agent.
Required parameters: agent
disableAgent - Disable an agent.
Required parameters: agent
addAgentAssignment - Assign a project, plan, or job to a specific agent. This makes the agent is dedicated to only perform builds for all assignments. Use continue to ignore already exists error.
Required parameters: agent, assignment
Optional parameters: continue
removeAgentAssignment - Remove an assignment from a specific agent. Use continue to ignore not found error.
Required parameters: agent, assignment
Optional parameters: continue
