Action Types
Check
| Action | Description | Required Parameters | Optional Parameters | Category |
|---|---|---|---|---|
| sleep | Sleep a number of seconds. Defaults to 1 second. Use in CLI scripts that may need to wait before proceeding to the next action. For instance, waiting for server to complete updating search indexes or polling type scenarios. |
|
Create
| Action | Description | Required Parameters | Optional Parameters | Category |
|---|---|---|---|---|
| addDownload | Add a download file to a repository. | |||
| addEnvironment | Add deployment environment. Type must be one of Test, Staging, or Production. Premium plan users can use '--options adminOnly' to restrict who can deploy to this environment. | |||
| addVariables | Add workspace, repository, or deployment environment variables. Use one or more field parameters where each field parameter is a key=value pair. Specify a secured variable by appending ':secured' like key=value:secured. To secure all variables added, use the secured parameter. Variables can also be added from a property file using the propertyFile parameter. | environment, field, propertyFile, secured, findReplace, findReplaceRegex | ||
| createProject | Create a new project. | |||
| provideFeedback | Provide feedback, comments, and suggestions to ACLI developers based on your experience with the product. We appreciate all feedback in the spirit of continuous improvement in helping customers with their tasks. For specific product issues and immediate help, please submit a request to our support portal at https://bobswift.atlassian.net/servicedesk. |
|
Delete
| Action | Description | Required Parameters | Optional Parameters | Category |
|---|---|---|---|---|
| deleteProject | Delete project. |
| ||
| removeDownload | Remove download from repository download area. | |||
| removeEnvironment | Remove deployment environment by name or UUID. | |||
| removePipelineCache | Remove a pipeline cache by name or UUID. | |||
| removeVariables | Remove workspace, repository, or deployment environment variables. Specify the variable names using the field parameters. Variables can also be removed by keys specified in a property file using the propertyFile parameter. |
Get
| Action | Description | Required Parameters | Optional Parameters | Category |
|---|---|---|---|---|
| getBranch | Get repository branch information. | |||
| getBranchList | Get List of branches with optional regex filtering on name. | workspace, regex, columns, select, options, file, encoding, append | ||
| getBuildStatusList | Get a list of build status entries associated with a repository branch including Bitbucket pipelines, Bamboo builds, and other CI servers like AWS and Azure. | workspace, regex, limit, columns, select, options, file, encoding, append | ||
| getClientInfo | Get information about this client. |
| outputFormat, file, limit, regex, append, encoding, columns, select, options | |
| getCommit | Get repository commit information. | |||
| getCommitList | Get list of commits with optional regex filtering on commit message and commit id. | workspace, regex, columns, select, options, file, encoding, append, limit | ||
| getDeploymentList | Get a list of repository deployments matching the selection criteria and optional regex filtering on name, key (slug), or UUID. | workspace, regex, limit, columns, select, options, file, encoding, append | ||
| getDownload | Get repository download file by name. | |||
| getDownloadList | Get a list of downloads for a repository with regex filtering on download name. | file, limit, regex, dateFormat, columns, select, options, encoding, append, outputFormat | ||
| getEnvironment | Get deployment environment by name or UUID. | |||
| getEnvironmentList | Get a list of repository deployment environments matching the selection criteria and optional regex filtering on name or UUID. | workspace, regex, limit, columns, select, options, file, encoding, append | ||
| getFileList | Get file and directory list with regex filtering on path. | revision, descendents, outputFormat, regex, limit, columns, select, options, file, encoding, append | ||
| getPipeline | Get pipeline by pipeline number. This action supports wait and related parameters similar to the startPipeline action. See the startPipeline action for more information. | |||
| getPipelineCacheList | Get list of pipeline caches for a repository with regex filtering on path. | workspace, regex, columns, select, options, file, encoding, append | ||
| getPipelineList | Get list of pipelines runs normally ordered by descending pipeline id. | workspace, regex, columns, select, options, file, encoding, append | ||
| getProject | Get project information. | |||
| getProjectList | Get a list of projects which belongs to the given workspace. |
| workspace, regex, limit, columns, select, options, file, encoding, append, dateFormat | |
| getPullRequest | Get pull request information under a repository. | |||
| getPullRequestList | Get List of pull requests for a user with optional filtering on repository, state and optional regex filtering on title,description. | workspace, state, regex, columns, select, options, file, encoding, append | ||
| getReplacementVariableList | Get a list of replacement variable names and values with regex filtering on name. This action is only useful within a run script where replacement variables are remembered. |
| ||
| getRepository | Get repository information. | |||
| getRepositoryList | Get a list of repositories matching the selection criteria and optional regex filtering on name or slug or UUID. |
| workspace, regex, limit, columns, select, options, file, encoding, append | |
| getRunnerList | Get list of pipeline runners for a workspace or a repository. | workspace, regex, columns, select, options, file, encoding, append | ||
| getSource | Get source. | |||
| getTeam | Get team information. | file, encoding, append, role, dateFormat | ||
| getTeamList | Get a list of teams matching the selection role criteria. |
| role, regex, limit, columns, select, options, file, encoding, append, dateFormat | |
| getUpgradeInfo | Get information about upgrades available for this client. |
| ||
| getUser | Get user information for current user. |
| ||
| getVariableList | Get a list of workspace, repository, or deployment environment variables based on regex filtering on variable names. To get variables for all environments for a repository, set the environment parameter to @all. | environment, regex, columns, select, options, reference, file, append, encoding | ||
| getWorkspace | Get workspace information. | |||
| getWorkspaceList | Get a list of workspaces with regex filtering based on name or key. |
| regex, limit, columns, select, options, file, encoding, append, dateFormat | |
| help | Show general help information for the client including actions and parameters. When used on a partial action string, action specific help will be shown. |
|
| |
| renderRequest | Render URL based request. URL can be a partial Bitbucket Cloud URL. The response data modified by optional findReplace processing is returned. Use '--pretty' to format returned JSON data in a more readable form. | requestType, data, contentType, acceptType, file, encoding, findReplace, findReplaceRegex, header |
Publish
| Action | Description | Required Parameters | Optional Parameters | Category |
|---|---|---|---|---|
| publishSource | Publish source to Confluence. When the path represents a directory, all files included in the same file list filtering conditions as getFileList will be published to the page. |
Run
| Action | Description | Required Parameters | Optional Parameters | Category |
|---|---|---|---|---|
| run | Run actions from a file, list of input parameters, or standard input (default). Use one or more field parameters to set replacement variables that can be used in run script actions. This makes it possible to parameterize the script so it can be applied to more general use cases. For example, '--field project=MYPROJECT'. This capability is available for all run type actions. |
| file, input, common, continue, simulate, field, file, encoding, clearFileBeforeAppend, findReplace, findReplaceRegex | |
| runFromCsv | Run actions generated from a CSV file. The default behavior is that each column name that matches a valid parameter for the client generates a parameter with value matching the column value for the row being process. Alternatively, use '--options setReplacementVariables' to change the behavior to set a replacement variable whose key (case sensitive) is the column name with blanks removed and whose valid is the value matching the column value for the row being processed. | propertyFile, common, input, continue, simulate, field, encoding, clearFileBeforeAppend, findReplace, findReplaceRegex | ||
| runFromDeploymentList | Run actions for each deployment associated with a repository with regex filtering on deployment name equivalent to getDeploymentList. | repository, input - common - file | workspace, regex, limit, continue, simulate, field, encoding, clearFileBeforeAppend, findReplace, findReplaceRegex, options | |
| runFromDownloadList | Run actions for each download associated with a repository with regex filtering on download name equivalent to getDownloadList. | repository, input - common - file | workspace, regex, limit, continue, simulate, field, encoding, clearFileBeforeAppend, findReplace, findReplaceRegex, options | |
| runFromEnvironmentList | Run actions for each deployment environment associated with a repository with regex filtering on environment name equivalent to getEnvironmentList. | repository, input - common - file | workspace, regex, limit, continue, simulate, field, encoding, clearFileBeforeAppend, findReplace, findReplaceRegex, options | |
| runFromJson | Run actions based on JSON data used for replacement variables and list processing based on standard Json paths specified for list and list2 parameters. Valid JSON data must be provided using the data parameter or file parameter. Actions can be specified using input, common, or file (when not used for data) parameters. Replacement variables are defined from the JSON data using JsonPath naming convention with dot separators. See the JsonPath reference at https://github.com/json-path/JsonPath/blob/master/README.md. | list, list2, continue, simulate, field, encoding, clearFileBeforeAppend, findReplace, findReplaceRegex, options | ||
| runFromList | Run actions for each entry in a list with corresponding entry replacement variable. 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. When available, list2 entries provide values for the entry2 replacement variable. By default, the entry2 replacement variable is set in parallel with entry replacement variables for each action run. However, if '--options listProcessing=serial' is specified, each combination of entries from list and list2 will cause an action to run. Use one or more field parameters to set replacement variables that can be used in run script actions. This makes it possible to parameterize the script so it can be applied to more general use cases. For example, '--field project=MYPROJECT'. | list2, continue, simulate, field, encoding, clearFileBeforeAppend, findReplace, findReplaceRegex, options | ||
| runFromProjectList | Run actions for each project with regex filtering on project key or name equivalent to getProjectList. | workspace, regex, limit, continue, simulate, field, encoding, clearFileBeforeAppend, findReplace, findReplaceRegex, options | ||
| runFromPropertyFile | Run actions for each entry from a (Java) property file. | continue, simulate, field, encoding, clearFileBeforeAppend, findReplace, findReplaceRegex, options | ||
| runFromRepositoryList | Run actions for each repository with regex filtering on repository key or name equivalent to getRepositoryList. | workspace, regex, limit, continue, simulate, field, encoding, clearFileBeforeAppend, findReplace, findReplaceRegex, options | ||
| runFromSql | Run actions generated by SQL provided by the sql parameter, a file, or standard input. The default behavior is that each column name that matches a valid parameter for the client generates a parameter with value matching the column value for the row being process. A special case is if the value of the first column starts with a '-', then the entire row will be treated as a single action. Alternatively, use '--options setReplacementVariables' to change the behavior to set a replacement variable whose key (case sensitive) is the column name, with blanks removed, and whose valid is the value matching the column value for the row being processed. | database, url, dbUser, dbPassword, propertyFile, common, input, continue, simulate, field, encoding, clearFileBeforeAppend, findReplace, findReplaceRegex | ||
| runFromWorkspaceList | Run actions for each workspace with regex filtering on workspace key or name equivalent to getWorkspaceList. | regex, limit, continue, simulate, field, encoding, clearFileBeforeAppend, findReplace, findReplaceRegex, options | ||
| runIf | Run actions only if a regex based condition is met. Other parameters and behavior are the same as the run action. By default the regex is used for a find of the value parameter. Options parameter can be set to one or more of the following to modify the default behavior: literal - to treat the regex string as a literal string, exact - to require an exact match of the value, negative - to reverse the condition so a match means do NOT run action. Use one or more field parameters to set replacement variables that can be used in run script actions. This makes it possible to parameterize the script so it can be applied to more general use cases. For example, '--field project=MYPROJECT'. | value, options, common, continue, simulate, field, encoding, clearFileBeforeAppend, findReplace, findReplaceRegex |
Start
| Action | Description | Required Parameters | Optional Parameters | Category |
|---|---|---|---|---|
| startPipeline | Start a pipeline run. Field parameters can be used to provide variable settings for a custom pipeline run. Use the wait parameter to wait for the pipeline to be COMPLETED (or other state provided by the state parameter) before the action completes. When waiting for a COMPLETED pipeline, the action will fail if the pipeline result is not successful unless the continue parameter is specified. Alternatively, the same wait related parameters can a used on a separate getPipeline action enabling multiple pipelines to be started in a script without wait and then followed later by getPipeline with wait to handle results. | workspace, branch, commit, selector, selectorType, wait, state, timeout, continue, field |
Update
| Action | Description | Required Parameters | Optional Parameters | Category |
|---|---|---|---|---|
| setReplacementVariables | Set one or more replacement variables specified using field parameters with name=value syntax or loaded from a property file. Value specified replaces any previously set variable with the same name including values set by other actions that set replacement variables. This is an example to save a previously set value: --field myIssue=@issue@. Find and replace logic is applied to the value before setting the variable providing a way to manipulate values in a script. Variables are available only within the scope of the run script they were set in. |
| ||
| updateProject | Update an existing project. | |||
| updateVariables | Update workspace, repository, or deployment environment variables. Use one or more field parameters where each field parameter is a key=value pair. Specify a secured variable by appending ':secured' like key=value:secured. To secure all variables added or updated, use the secured parameter. Variables can also be updated from a property file using the propertyFile parameter. | environment, field, append, propertyFile, secured, findReplace, findReplaceRegex |