Related information
Help text
Generated documentation
The information in this section is automatically generated.
This is the help text displayed by the default command or using --help. This gives the precise definition of parameters. The online reference contains the same information and is easier to use.
Common parameters
A few common parameters are available that are not specifically listed as optional parameters for each action: help, verbose, debug, quiet, special, dateFormat, dateFormat2, and outputType. Similarly for database related parameters that are optional for all get list actions: url, dbUser, dbPassword, database, driver, dbJar, host, port, dbCreateTable, dbTable, dbTableKeys, afterSql, and propertyFile.
Tips
- To get help for a specific action, type the action followed by --help - example: --action getProjectList --help
- Use double dash for multi-letter parameters - example: --help
- Use single dash for single letter parameters indicated in the Short column in parameter help - example: -v
- When parameters are specified, most need a value as indicated by a check in the Value column in parameter help - example: --action addPage
- Some parameters are flags (boolean) and must not be followed by a value - example: --verbose
- Parameter names are case sensitive, but, action values are not - example: --userid is invalid but --action addpage is equivalent to --action addPage
- An incorrect case parameter will result in an unknown parameter error and show action help with correctly cased parameter (9.8 or higher)
- Some parameters become required once a specific action is chosen. This is indicated in the action help text as required.
- Some parameters have both short (one letter) and long (more than one letter) parameter names - example: -a or --action are the same and cannot both be specified
- Some parameters have default values, if so, they are indicated in the help text
- Values that contain blanks or some special characters (platform specific) must be enclosed by double quotes - example: --title "this is my title"
- Quoting rules in commands can vary by terminal environment:
- Windows command terminals or run action scripts for all platforms: embedded double quotes within a double quoted string must be escaped by doubling the double quote - example: –common "-a addComment --comment ""This is an example of a double quoted string inside a double quote"" "
- Linux and Mac/OSX command terminals require standard Linux style escaping: embedded double quotes within a double quoted string can be escaped with a \ - example: –common " -a addComment --comment \"This is an example of a double quoted string inside a double quote\" "
- Run CLI Actions usage: embedded double quotes within a double quoted string can be escaped by doubling the double quote (first example above)
- A single quote sometimes can used in place of a double quotes on some command terminal environments - example: –common '-a addComment --comment "This is an example of a double quoted string inside a double quote" '
- Some parameters allow entry of a comma separated list of values, values containing a comma must be enclosed in single quotes - example: --custom "'first:a,b,c', second:x". Embedded single quotes within a quoted string must be doubled
- Some text fields support the automatic conversion of " \n " (blanks are significant) to be replaced with a new line character - example: --description "A multi-line text field: \n # line 1 \n # line 2"
Special parameter
Some special characters are difficult to deal with or make action text very complicated. This is because they have special meaning in either the OS command terminal handling, the tool's command line parsing, or the tool's use of separators (like comma or colon separated lists). As a convenience to avoid some of these nasty situations, a special parameter was implemented to allow alternate characters to be used instead of (or in addition to) the problematic characters within parameter values. The choice of what special characters to use depends on the content so that you do not have conflicts with intended content. The special parameter works by the user providing a order specific alternate character. The alternative character is replaced with the real character after all other parsing occurs. It is implemented for many action parameters that are problematic in this area. Not all situations are covered, but, that will improve as other use cases are identified.
| Position | Character | Character name | Suggested alternate | Usage |
|---|---|---|---|---|
| 1 | , | comma | Some parameters use comma separated lists. | |
| 2 | : | colon | # | Some parameters use colon separated values. |
| 3 | @ | at sign | Replacement variables syntax: @...@. | |
| 4 | ' | single quote | Used in separated lists to cover cases where content contains separator. | |
| 5 | " | double quote | ~ | Parameters containing blanks. |
| 6 | ^ | caret | Substitution double quote indicator: ^^...^^. See ACLI-673 for details. |
A blank in any position is ignored (no alternate provided).
Example: –special " # ~" provides alternates for colon and double quote.
--common "--findReplace ~something to find containing a : (colon)#replacement~"
Character Set
User and password values should be in the ISO-8859-1 character set. Also avoid characters that require escaping on your OS command terminal. Non standard characters will result in an authorization error similar to: User is not authorized to perform the request.
3.1.0
Usage:
bamboo (-a|--action) <action> [(-f|--file) <file>] [--encoding <encoding>] [--debug] [-v|--verbose] [--quiet] [--outputFormat
<outputFormat>] [--connectionTimeout <connectionTimeout>] [--sql <sql>] [--driver <driver>] [--url <url>] [--host <host>] [--port
<port>] [--database <database>] [--dbUser <dbUser>] [--dbPassword <dbPassword>] [--propertyFile <propertyFile>] [--common <common>]
[--findReplace <findReplace>] [--findReplaceRegex <findReplaceRegex>] [--list <list>] [--continue] [--simulate] (-s|--server)
<server> (-u|--user) <user> (-p|--password) <password> [--login <login>] [--service <service>] [--api <api>] [--project <project>]
[--toProject <toProject>] [--build <build>] [--plan <plan>] [--toPlan <toPlan>] [--job <job>] [--name <name>] [--description
<description>] [--artifact <artifact>] [--labels <labels>] [--searchLabels <searchLabels>] [--issues <issues>] [--expand <expand>]
[--attribute <attribute>] [--comment <comment>] [--taskKey <taskKey>] [--fields <fields>] [--field1 <field1>] [--field2 <field2>]
[--field3 <field3>] [--field4 <field4>] [--value1 <value1>] [--value2 <value2>] [--value3 <value3>] [--value4 <value4>] [--request
<request>] [--requestParameters <requestParameters>] [--id <id>] [--number <number>] [--timeout <timeout>] [--wait] [--favourite]
[--disable] [-l|--loginFromStandardInput] [--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 (not case sensitive) are:
login - Legacy. Login to remote server. Returns login token.
Required parameters: password
Optional parameters: user
logout - Legacy. Logout of remote server.
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, host, 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. @entry@ will
be replaced with the entry value.
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.
renderRequest - Render url based request. The response data modified by findReplace processing is returned.
Required parameters: request
Optional parameters: requestParameters, build, file, encoding, findReplace, findReplaceRegex
getProjectList - Get a list of projects.
Optional parameters: file, attribute, expand
getPlanList - Get a list of build plans.
Optional parameters: project, favourite, file, attribute, expand
getBuildList - Get a list of builds.
Optional parameters: file, attribute, favourite, expand, labels, issues
getBuildQueueList - Get a list of builds waiting in the build queue. Subset by project or build.
Optional parameters: project, build, file
getLabelList - Get a list of labels for a build.
Required parameters: build
Optional parameters: number, file
getCommentList - Get a list of comments for a build.
Required parameters: build
Optional parameters: number, file
getLatestBuildResults - Legacy. Get build results for a build or project.
Required parameters: build or project
Optional parameters: file
triggerBuild - Legacy - use queueBuild instead. Triggers a build if there are source changes.
Required parameters: build
queueBuild - Queue a build to run. Specify build key.
Required parameters: build
Optional parameters: wait, 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
getProject - Legacy. Get project information.
Required parameters: project
Optional parameters: file
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. Bamboo 3.3 and above.
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. Bamboo 3.3 and above.
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. Bamboo 3.3 and above.
Required parameters: plan, job, id
[(-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)
[--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.
[--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 login. (default: automation)
(-p|--password) <password>
User password for remote login.
[--login <login>]
Login token from previous login request.
[--service <service>]
Service address extension. (default: /rest/api)
[--api <api>]
API version. Some requests produce different results based on the api version used. Use 0 for latest. (default: 0)
[--project <project>]
Project key. Example: XXX
[--toProject <toProject>]
Project key to clone to.
[--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
[--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.
[--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
[--taskKey <taskKey>]
Task key. Example: com.atlassian.bamboo.plugins.scripttask:task.builder.script
[--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.
[--request <request>]
URL fragment for a request.
[--requestParameters <requestParameters>]
URL request parameters
[--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)
[--wait]
Wait for action to complete.
[--favourite]
Subset to favourites.
[--disable]
Disable plan after it is created.
[-l|--loginFromStandardInput]
Get login token from standard input. Only applies to lLegacy client actions!
[--help]
Prints this help message.
