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] (-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>] [--artifact <artifact>] [--requirement <requirement>] [--type <type>] [--value <value>] [--labels
<labels>] [--searchLabels <searchLabels>] [--issues <issues>] [--expand <expand>] [--attribute <attribute>] [--comment <comment>]
[--revision <revision>] [--taskKey <taskKey>] [--repositoryKey <repositoryKey>] [--fields <fields>] [--field1 <field1>] [--field2
<field2>] [--field3 <field3>] [--field4 <field4>] [--value1 <value1>] [--value2 <value2>] [--value3 <value3>] [--value4 <value4>]
[--regex <regex>] [--request <request>] [--requestParameters <requestParameters>] [--requestType <requestType>] [--acceptType
<acceptType>] [--id <id>] [--number <number>] [--timeout <timeout>] [--limit <limit>] [--wait] [--favourite] [--disable] [--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.
[--simulate]
Simulate running actions. Log the action that would be taken.
(-s|--server) <server>
Server URL.
(-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. Optionally, for some actions, may contain build number. Example: XXX-DEF or XXX-DEF-1
[--plan <plan>]
Build plan key containing the project key. Example: XXX-DEF
[--toPlan <toPlan>]
Build plan key to be created. Example: XXX-DEF
[--stage <stage>]
Stage name.
[--job <job>]
Job key. Example: JOB1
[--name <name>]
Build plan name.
[--description <description>]
Build plan description.
[--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.
[--taskKey <taskKey>]
Task key. Example: com.atlassian.bamboo.plugins.scripttask:task.builder.script
[--repositoryKey <repositoryKey>]
Repository key. Example: com.atlassian.bamboo.plugins.atlassian-bamboo-plugin-mercurial:hg
[--fields <fields>]
Use to specify task specific fields or build 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.
[--field1 <field1>]
Task specific field or build variable name. Complements the fields parameter. Value is specified by the value1 parameter.
[--field2 <field2>]
Task specific field or build variable name. Complements the fields parameter. Value is specified by the value2 parameter.
[--field3 <field3>]
Task specific field or build variable name. Complements the fields parameter. Value is specified by the value3 parameter.
[--field4 <field4>]
Task specific field or build variable name. Complements the fields parameter. Value is specified by the value4 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.
[--regex <regex>]
Regular expression for including matching content.
[--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>]
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.
[--disable]
Disable plan after it is created.
[--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, 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, encoding, findReplace, findReplaceRegex
runFromCsv - Run actions generated from a CSV file.
Required parameters: file
Optional parameters: common, propertyFile, continue, quiet, simulate, 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, encoding, findReplace, findReplaceRegex
getClientInfo - Get information about the this client tool.
getServerInfo - Get information about the Bamboo server.
Optional parameters: outputFormat, dateFormat
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
getProjectList - Get a list of projects in csv format. Projects are select based on regex filtering on project key or name. Legacy list support is deprecated and will be removed.
Optional parameters: regex, file, encoding, columns
getPlanList - Get a list of build plans.
Optional parameters: project, favourite, file, attribute, expand, columns
getBuildList - Get a list of builds.
Optional parameters: file, attribute, favourite, expand, labels, issues, columns
getBuildQueueList - Get a list of builds waiting in the build queue. Subset by project or build.
Optional parameters: project, build, file, columns
getLabelList - Get a list of labels for a build.
Required parameters: build
Optional parameters: number, file, columns
getCommentList - Get a list of comments for a build.
Required parameters: build
Optional parameters: number, file, columns
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, file, encoding, findReplace, findReplaceRegex
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.
Required parameters: build
Optional parameters: revision, wait, continue, timeout, fields, field1, value1, field2, value2, field3, value3, field4, value4
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 - Delete 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, favourite
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 build plan in a project to another project.
Required parameters: project, toProject, disable
getPlan - Get build plan information.
Required parameters: plan
clonePlan - Clone a build plan.
Required parameters: plan, toPlan
Optional parameters: name, description, disable
deletePlan - Delete a build plan.
Required parameters: plan
enablePlan - Enable a build plan to run.
Required parameters: plan
disablePlan - Disable a build plan from running.
Required parameters: plan
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.
Required parameters: build
addTask - Add a task to a build plan job.
Required parameters: plan, job, taskKey
Optional parameters: fields, field1, value1, field2, value2, field3, value3, field4, value4
updateTask - Update a task in a build plan job.
Required parameters: plan, job, id
Optional parameters: fields, field1, value1, field2, value2, field3, value3, field4, value4
removeTask - Remove a task from a build plan job.
Required parameters: plan, job, id
addRepository - Add a source repository to a build plan.
Required parameters: plan, repositoryKey
Optional parameters: fields, field1, value1, field2, value2, field3, value3, field4, value4
updateRepository - Update a source repository for a build plan.
Required parameters: plan, id
Optional parameters: fields, field1, value1, field2, value2, field3, value3, field4, value4
removeRepository - Remove a source repository from a build plan.
Required parameters: plan, id
addRequirement - Beta. Add requirement to a plan job.
Required parameters: plan, job, requirement
Optional parameters: type, value
updateRequirement - Beta. Update a plan requirement.
Required parameters: plan, job, id
Optional parameters: type, value
removeRequirement - Beta. Remove a plan requirement.
Required parameters: plan, job, id
