Release notes 2.4

19 Dec 2011


This release focused on expanding JIRA and Bamboo support and covering new product releases. Bamboo support now includes cloning build plans, adding tasks, enabling and disabling build plans or projects. This is a simultaneous release of all CLI clients except for the Crowd CLI - see note. The Atlassian Command Line Interface (CLI) distribution contains all CLI clients (except Crowd) plus the atlassian script and additional examples and help text shipped with the distribution.


The Atlassian Command Line Interface (CLI) supports a large range of product releases. The matrix below provides compatibility guidelines based on testing, API compatibility information provided in Atlassian, and community feedback. User's are encourage to help improve compatibility information through discussions and issues. The CLI also works with releases not officially listed here since in many cases it uses remote APIs provided by Atlassian that have been stable for many years. Check previous versions of the CLI for coverage of earlier releases. Users should verify their usage scenarios on new releases. Support normally is limited to minimum releases indicated. Client requires Java 1.6 (recommended) or above. Testing is only done on Java 1.6. In some cases, new actions are only available on against later versions of the server - these are usually noted in the documentation.


  1. Confluence 4.1 introduced an incompatibility for adding comments - CONF-24194 (fixed in 4.1.3)
  2. Some of the newer JIRA CLI actions and other improvements are based on JIRA new REST apis. These APIs started being available with JIRA 4.2 and were significantly enhanced in JIRA 4.3 and later. Attempts to use these actions prior to the supporting JIRA release will result in appropriate error messages. Existing functions will still work on releases prior to 4.2, but releases earlier than 4.2 will no longer be automatically tested.
  3. JIRA 4.4 incompatibility bug regarding some custom field handling - see JRA-25034 and JRA-25732. JIRA 4.4.3 or higher is recommend if you plan to use JIRA 4.4.x
  4. Bamboo 3.3 or higher is required for action dealing with tasks
  5. Bamboo 3.4 is recommended for artifact handling due to BAM-9990

Highlights of Atlassian Command Line Interface (CLI) 2.4

JIRA Command Line Interface (CLI) Improvements

  1. JIRA 5.0 support
  2. More schemes on create and update project actions
  3. Archive version action


type key summary reporter assignee priority status

Bamboo Command Line Interface (CLI) Improvements

Major new actions including:

  1. addTask, updateTask, and *removeTask
  2. clonePlan and cloneProject
  3. deletePlan and deleteProject
  4. enablePlan, disablePlan, enableProject, and disableProject
  5. addComment and getCommentList
  6. verifyBuild
  7. getBuildQueueList
  8. queueBuild now can run parameterized builds (BCLI-11)


type key summary reporter assignee priority status

Confluence Command Line Interface (CLI) Improvements


type key summary reporter assignee priority status

Run CLI Actions in Confluence add-on

Atlassian CLI actions can now be run directly from within Confluence. This enables administrators to more easily document and run common automation steps. It also allows administrators to selectively enable self-service actions within a Confluence context using Run Self-Service Reports for Confluence, Scripting for Confluence, or similar.

More details are available on the add-on page - Run CLI Actions in Confluence

Release strategy

2.4.0 is the first release of this add-on. It is planned to concurrently release this add-on with each new release of the Atlassian CLI.


  1. Supports all clients included with the Atlassian CLI distribution
  2. Command and input data from macro body, attachment, or file system
  3. Display options - showCommand, panel, hideOutput
  4. Option to render body before processing - macros=true
  5. Password suppression on display
  6. datasource parameter for runFromSql action - same as SQL for Confluence add-on's datasource parameter, requires application server datasource configuration
  7. Security control (optional) via Macro Security for Confluence for add-on use and access to advanced parameters (profile, product, directory)


--action runFromSql
select '--action addLabels --labels "test" --space zcli --title "' || title || '"' from content where spaceid in (select spaceid from spaces where spacekey = 'zcli')

Common Improvements


type key summary reporter assignee priority status

Crowd temporarily discontinued


Crowd CLI removed from distribution

The Crowd Command Line Interface (CLI) has been temporarily suspended from further development until the APIs are improved. As previously noted, Atlassian completely removed the Crowd remote APIs used for the CLI (sad) starting with Crowd 2.1. New replacement APIs do not cover most of the existing functionality. Atlassian is currently targeting application use cases and not automation capabilities for the Crowd APIs. It will be a while to sort out how the Crowd CLI moves forward, until then, the Crowd CLI has been removed from the distribution.