Related information
See Action Reference for all CLI products including archives and EAP SNAPSHOTS.
The information in this section is automatically generated.
3.0.0
Action, Category, Description, Required parameters, Optional parameters, Output formats
"addComment ", "Comments", "Add a comment to a build.", "build, comment", "number, findReplace, findReplaceRegex, file, encoding",
"addLabels ", "Labels", "Add a comma separated list of labels to a build.", "build, labels", "number",
"addTask ", , "Add a task to a build plan job. Bamboo 3.3 and above.", "plan, job, taskKey", "fields, field1, value1, field2, value2, field3, value3, field4, value4",
"clonePlan ", "Plans", "Clone a build plan.", "plan, toPlan", "name, description, disable",
"cloneProject ", "Projects", "Clone each build plan in a project to another project.", "project, toProject, disable", ,
"deletePlan ", "Plans", "Delete a build plan.", "plan", ,
"deleteProject ", "Projects", "Delete project and all project plans.", "project", "file",
"disablePlan ", "Plans", "Disable a build plan from running.", "plan", ,
"disableProject ", "Projects", "Disable all project plans.", "project", ,
"enablePlan ", "Plans", "Enable a build plan to run.", "plan", ,
"enableProject ", "Projects", "Enable all project plans.", "project", ,
"getArtifact ", "Artifacts", "Download a copy of a build artifact into a file.", "build, artifact, file", "number",
"getBuildList ", "Lists", "Get a list of builds.", , "file, attribute, favourite, expand, labels, issues",
"getBuildQueueList ", "Lists", "Get a list of builds waiting in the build queue. Subset by project or build.", , "project, build, file",
"getBuild ", "Builds", "Get build result.", "build", "number, expand, file",
"getClientInfo ", "Info", "Get information about the this client tool.", , ,
"getCommentList ", "Lists", "Get a list of comments for a build.", "build", "number, file",
"getLabelList ", "Lists", "Get a list of labels for a build.", "build", "number, file",
"getLatestBuildNumber ", "Builds", "Get the number of the last completed build.", "build", ,
"getLatestBuildResults ", "Builds", "Legacy. Get build results for a build or project.", "build or project", "file",
"getPlanList ", "Lists", "Get a list of build plans.", , "project, favourite, file, attribute, expand",
"getPlan ", "Plans", "Get build plan information.", "plan", ,
"getProjectList ", "Lists", "Get a list of projects.", , "file, attribute, expand",
"getProject ", "Projects", "Legacy. Get project information.", "project", "file",
"getServerInfo ", "Info", "Get information about the Bamboo server.", , ,
"login ", "Misc", "Legacy. Login to remote server. Returns login token.", "password", "user",
"logout ", "Misc", "Legacy. Logout of remote server.", , ,
"queueBuild ", "Builds", "Queue a build to run. Specify build key.", "build", "wait, timeout, fields, field1, value1, field2, value2, field3, value3, field4, value4",
"removeLabels ", "Labels", "Delete labels from a build. Labels can be a comma separated list or regex. Either build or search terms (searchLabels, issues) must be provided", "labels", "build, number, searchLabels, issues, favourite",
"removeTask ", , "Remove a task from a build plan job. Bamboo 3.3 and above.", "plan, job, id", ,
"renderRequest ", "Render", "Render url based request. The response data modified by findReplace processing is returned.", "request", "requestParameters, build, file, encoding, findReplace, findReplaceRegex",
"runFromCsv ", "Run", "Run actions generated from a CSV file.", "file", "common, propertyFile, continue, quiet, simulate, encoding, findReplace, findReplaceRegex",
"runFromList ", "Lists", "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.", "list", "file, common, continue, quiet, simulate, encoding, findReplace, findReplaceRegex",
"runFromSql ", "Run", "Run actions generated.by SQL provided by the sql parameter, a file, or standard input", "sql or file or standard input", "common, host, driver, database, host, port, url, dbUser, dbPassword, propertyFile, continue, simulate, encoding, findReplace, findReplaceRegex",
"run ", "Run", "Run actions from a file or standard input.", "file or standard input", "common, continue, simulate, encoding, findReplace, findReplaceRegex",
"triggerBuild ", "Builds", "Legacy - use queueBuild instead. Triggers a build if there are source changes.", "build", ,
"updateTask ", , "Update a task in a build plan job. Bamboo 3.3 and above.", "plan, job, id", "fields, field1, value1, field2, value2, field3, value3, field4, value4",
"verifyBuild ", "Builds", "Verify build was successful.", "build", "number",
Parameters
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.
Parameter, Short, Value, Description
"action ", "a", "
",
"api ", , "", "API version. Some requests produce different results based on the api version used. Use 0 for latest. (default: 0)"
"artifact ", , "", "Build artifact name. May be extended by a path name for locating files within an artifact representing a dirctory."
"attribute ", , "", "Attribute to list."
"build ", , "", "Build key. Optionally, for some actions, may contain build number. Example: XXX-DEF or XXX-DEF-1"
"comment ", , "", "Comment for an build"
"common ", , "", "Common parameter string added to all run actions."
"connectionTimeout ", , "", "Allow overriding environment settings for connect and read timeouts on URL connections. In milliseconds, 0 means infinite."
"continue ", , "
", "Continue processing even after errors are encountered."
"database ", , "", "Database name is required for SQL actions."
"dbPassword ", , "", "Database user password. Defaults to password."
"dbUser ", , "", "Database user name. Defaults to user."
"debug ", , "", "Requests detail debug output. Optional for all actions."
"description ", , "", "Build plan description."
"disable ", , "", "Disable plan after it is created."
"driver ", , "", "JDBC driver class or predefined value: postgresql, mysql, mssql, oracle, or db2400. Required for SQL actions."
"encoding ", , "", "Character encoding (character set) for text based file content - must be an encoding supported by your JAVA platform."
"expand ", , "", "Expanded request information to obtain more detailed data on request."
"favourite ", , "", "Subset to favourites."
"field1 ", , "", "Task specific field or build variable name. Complements the fields parameter. Value is specified by the value1 parameter."
"field2 ", , "", "Task specific field or build variable name. Complements the fields parameter. Value is specified by the value2 parameter."
"field3 ", , "", "Task specific field or build variable name. Complements the fields parameter. Value is specified by the value3 parameter."
"field4 ", , "", "Task specific field or build variable name. Complements the fields parameter. Value is specified by the value4 parameter."
"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."
"file ", "f", "", "Path to file based content or result output. Use - for standard input."
"findReplace ", , "", "Find and replace text. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded quotes must be doubled."
"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."
"help ", , "", "Prints this help message."
"host ", , "", "Database host server for SQL actions. Not used if url is provided. (default: localhost)"
"id ", , "", "Task id."
"issues ", , "", "Comma separated list of JIRA issue keys."
"job ", , "", "Job key. Example: JOB1"
"labels ", , "", "Comma or blank separated list of labels."
"list ", , "", "Comma separated list of entries. Single quote values containing a delimiter. Embedded quotes must be doubled."
"login ", , "", "Login token from previous login request."
"loginFromStandardInput ", "l", "", "Get login token from standard input. Only applies to lLegacy client actions!"
"name ", , "", "Build plan name."
"number ", , "", "Build number. Defaults to latest. (default: 0)"
"outputFormat ", , "", "Specify output format for an action. (default: 1)"
"password ", "p", "", "User password for remote login."
"plan ", , "", "Build plan key containing the project key. Example: XXX-DEF"
"port ", , "", "Database host port for SQL actions. Optional, defaults to database default. Not used if url is provided."
"project ", , "", "Project key. Example: XXX"
"propertyFile ", , "", "Property file with mapping information."
"quiet ", , "", "Limit some output messages. Optional for all actions."
"request ", , "", "URL fragment for a request."
"requestParameters ", , "", "URL request parameters"
"searchLabels ", , "", "Comma or blank separated list of labels used for search."
"server ", "s", "", "Server URL."
"service ", , "", "Service address extension. (default: /rest/api)"
"simulate ", , "", "Simulate running actions. Log the action that would be taken."
"sql ", , "", "SQL select statement used to generate a run script."
"taskKey ", , "", "Task key. Example: com.atlassian.bamboo.plugins.scripttask:task.builder.script"
"timeout ", , "", "Wait timeout in seconds. Use -1 to wait forever. (default: -1)"
"toPlan ", , "", "Build plan key to be created. Example: XXX-DEF"
"toProject ", , "", "Project key to clone to."
"url ", , "", "Action specific setting. Example: Database access url for SQL actions. Optional when host is provided."
"user ", "u", "", "User name for remote login. (default: automation)"
"value1 ", , "", "Value corresponding to the field1 parameter name."
"value2 ", , "", "Value corresponding to the field2 parameter name."
"value3 ", , "", "Value corresponding to the field3 parameter name."
"value4 ", , "", "Value corresponding to the field4 parameter name."
"verbose ", "v", "", "Requests verbose output to help with problem determination. Optional for all actions."
"wait ", , "", "Wait for action to complete."
