Reviews and more information
- Atlassian Plugin Exchange - Bamboo Command Line Interface
- Atlassian Plugin Exchange - Atlassian Command Line Interface
Additional support information
Java 1.5 and above
Please open an issue for problem reports or more complex usage or support questions
CLI, 2.0, 2.1, 2.2, 2.3, 2.4, Tested releases, Notes
1.1.0, , , , , , "2.1.4, 2.3.1, 2.4.0"
This is a command line interface for remotely accessing Bamboo using Bamboo's REST APIs. This is a working command line client that can be used directly with your installation. It also serves as an example of using Java to access Bamboo's REST API to implement Bamboo automation. The client can run on any platform with Java 1.5 or higher. The Bamboo remote APIs are currently fairly limited, but likely to improve over time.
- Unzip the distribution package and put the enclosed directory in a convenient location
- Ensure Remote API is enabled in your installation
- You need to be an administrator
- Accept remote API calls? should be checked in the Administration - General Configuration section
- On a command line, cd to the directory where you installed the client
- On Windows
- Run bamboo
- On Linux, Mac, or Unix
- Run ./bamboo.sh
- On any system supporting java
- Run java -jar release/bamboo-cli-1.1.0.jar
- This will show help text for the command line interface client
- The client defaults to use a user of automation. Either add this user with all the authorities required to do the actions you want or specify a different user parameter
- It is recommended that you open the bamboo.bat file with an editor and customize it for your environment by adding server, user, and password parameters. Follow the example in the comments and make sure you do not remove the %* at the end of the line.
- This information is also available in the examples directory in the Atlassian Command Line Interface distribution.
- Note: the information in this section is automatically generated, so if you have edit suggestions, add a comment. Otherwise, your edits will likely be replaced on the next update.
- Note: the following examples assume that the bamboo.bat or bamboo.sh file has been customized for your environment as noted above.
- From a command line, change directory (cd) to the directory where the zip was unpacked
This is the help text displayed by the default command or using --help. This gives the precise definition of parameters, however, it might be easier to just look at the examples. Note, the information in this section is automatically generated, so if you have edit suggestions, add a comment. Otherwise, your edits will be replaced on the next update.
- Use single dash for single letter parameters - example: -v
- Use double dash for multi-letter parameter - example: --help
- When parameters are specified, most need a value - 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
- Some parameters become required once a specific action is chosen. This is indicated in the help text for each value.
- Some parameters have both short (one letter) and long (more than one letter) parameter names - example: -a or --action are the same
- Some parameters have default values, if so, they are indicated below - example: (default: automation)
- Some parameters are required - indicated by (...) - example: (-a|--action) <action>
- Some parameters are optional - indicated by [...] - example: [(-f|--file) <file>]
- Values that have more than one word must be enclosed by double quotes - example: --title "this is my title"