This page describes the shell script
atlas-cli, part of the Atlassian Plugin SDK.
Along with the plugin install (
pi) 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
pi 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:
atlas-cli [options]– Starts up a command line interface to your plugin running in the host application. After you change the plugin code, enter
piat the CLI prompt to install the updated plugin in the Atlassian application. (Runs
mvn amps:cli.) Interpreted parameters:
http-port, context-path, server, cli-port.
Available CLI commands:
pi— Plugin install. Installs your updated plugin into the application.
bye— Exits from the CLI.
This shell script supports some interpreted parameters, specified below. All other parameters are passed straight through to Maven.
Explaining the table columns:
- 'Full Parameter' and 'Shortened' – Some parameters allow you to choose a full or a shortened version of the parameter, others just support the full version.
- 'Accepts a Value?' – 'Yes' means that you should specify a value in addition to the parameter, e.g. for the 'version' parameter you should specify the version number. 'No' means that the parameter does not accept a value.
HTTP port for the servlet container, e.g.
The application context path. You will need to include the leading forward slash. For example, if your application is running at
To run your application in the root web application context (eg.
Host name of the application server. The default is
The port the CLI will listen to for commands. The default is
* Accepts a Value: yes.
The shell script will display some help text if you enter one of the following as the first argument:
Once you have done the initial
atlas-run, you can keep the application running in one command window and use the CLI (command line interface) to dynamically re-install your plugin after each change.
- Make your changes in your IDE.
- Open a command window and go to the plugin's root folder (where the
atlas-clito start the CLI.
- Wait until you see a message,
Waiting for commands.
pi(plugin install) to compile, package and install the plugin.
- Go back to your browser. The updated plugin will have been installed into the application, and you can test your changes. (You may need to refresh the browser page first.)