How to get the list of deployment projects in a file using Bamboo Command Line Interface (CLI)

This article explains how to get the list of deployment projects to a file in the Bamboo server using the app, Bamboo Command Line Interface.

Instructions

  • Use the getDeploymentProjectList to get a list of deployment projects based on regex filtering of project names.


    Execute the below CLI action with outputFormat 999:

    To get the list of all deployment projects in a project with Id, Name, Description, Plan fields.

    --action getDeploymentProjectList --outputFormat 999 --file projects.csv


    Below is the output of the file projects.csv:



The parameters used in the CLI action are 

--file  
--outputFormat

To get the resultant output in the same terminal remove --file and add --outputFormat 1 in the above CLI action.

  • It is recommended to test the commands in a non-production environment, or run the action with --simulate parameter to verify the behavior before deploying.
  • Ensure that the Bamboo Command Line Interface app is installed in your Bamboo instance.