How to update stage of the plan using Bamboo Command Line Interface

Owned by Manisha Kharga

Last updated: Jun 17, 2021 by Amith Mathur

1 min read

This article explains how to update the stage of a plan with Bamboo Command Line Interface (CLI).

Instructions

Use updateStage action to update a stage in a Bamboo plan.

Execute the below command to add a stage to a plan. For this instance, let's update a stage, Stage1, in the plan, TES-PLAN.

CLI action:
```
--action updateStage --plan "TES-PLAN" --stage "stage1" --manual --name "B updated" --description "Updated description"
```
After executing the CLI action, we are seeing the updated Stage details.

The parameters used with the action are:
- --plan value refers to the plan key.
- --description value refers to the stage description.
- --name value refers to the name of the stage.
- --manual indicates that a stage to be run manually.

It is recommended to test the command in a non-production environment before running in production, or, run the action with --simulate parameter to verify the behavior before deploying.