This page describes the shell script , part of the Atlassian Plugin SDK.
Along with the plugin install () command, this command allows you to install a plugin into a running Atlassian application, without having to restart the application. At the CLI prompt, you enter to install a plugin whenever you change its code.
Note that this mechanism is now incorporated in the user interface of Atlassian application as one of the developer tools. For more information, see Automatic Plugin Reinstallation with FastDev. If you want to avoid using FastDev but do want to use the command line mode as described here, add the following to the AMPS configuration in your project POM:
- Starts up a command line interface to your plugin running in the host application. After you change the plugin code, enter at the CLI prompt to install the updated plugin in the Atlassian application. (Runs .) Interpreted parameters: .Available CLI commands:
This shell script supports some interpreted parameters, specified below. All other parameters are passed straight through to Maven.
Explaining the table columns:
HTTP port for the servlet container, e.g. . The defaults are as described in the SDK overview. You may need to change this if you already have a process listed for the default port, such as when you want to bring up two instances of Confluence.
The application context path. You will need to include the leading forward slash. For example, if your application is running at localhost:1990/confluence then you should enter .
To run your application in the root web application context (eg. localhost:1990), then you should enter .
Host name of the application server. The default is .
The port the CLI will listen to for commands. The default is . You may need to change this if you already have a process listed for this port.
All above accepts a value.
The shell script will display some help text if you enter one of the following as the first argument:
atlas-cli -? atlas-cli -help
Once you have done the initial and , you can keep the application running in one command window and use the CLI (command line interface) to dynamically reinstall your plugin after each change.