Reviews and more information
- Atlassian Plugin Exchange - Crowd Command Line Interface
- Atlassian Plugin Exchange - Atlassian Command Line Interface
Additional support information
Command line interface client for Crowd
This is a command line interface (CLI) for remotely accessing Crowd. This provides a convenient way to automate Crowd administration and include Crowd content as part of other automation. Examples are build and test automation or other business processes. This is a working command line client that can be used directly with your installation. This CLI uses Crowd's REST remote API.
CLI, 2.0, Tested releases, Notes
1.0.0, , 2.0.1
- Unzip the distribution package and put the enclosed directory in a convenient location
- On a command line, cd to the directory where you installed the client
- On Windows
- Run crowd
- On Linux, Mac, or Unix
- Run ./crowd.sh
- On any system supporting Java
- Run java -jar release/crowd-cli-1.0.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 crowd.bat or crowd.sh 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.
- 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 crowd.bat or crowd.sh file has been customized for your environment as noted above.
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"