Command Reference

  • atlas-cleanatlas-clean [options] – Removes files from the project directory, that were generated during the build. (Runs mvn clean.) Passes all parameters straight through to Maven.
  • atlas-cliatlas-cli [options] – Starts up a command line interface to your plugin running in the host application. After you change the plugin code, enter pi at 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.
  • atlas-cloveratlas-clover [options] – Runs unit and integration tests, generating a code coverage report with Clover http://atlassian.com/clover. Passes all parameters straight through to Maven. Report is available in target/site/clover/index.html.
  • atlas-compileatlas-compile [options] – Compiles the sources of your project. (Runs mvn compile.) Passes all parameters straight through to Maven.
  • atlas-create-bamboo-pluginatlas-create-bamboo-plugin [options] – Creates an example of a Bamboo plugin, which you can adapt to suit your own plugin's needs. (Runs mvn bamboo:create.) Interpreted parameters: artifact-id, group-id, version, package, non-interactive.
  • atlas-create-bamboo-plugin-moduleatlas-create-bamboo-plugin-module [options] – Prompts you for plugin module type and related details, then creates an example of a Bamboo plugin module that you can adapt to suit your own plugin's needs. (Runs mvn bamboo:create-plugin-module.) Passes all parameters straight through to Maven.
  • atlas-create-confluence-pluginatlas-create-confluence-plugin [options] – Creates an example of a Confluence plugin, which you can adapt to suit your own plugin's needs. (Runs mvn confluence:create.) Interpreted parameters: artifact-id, group-id, version, package, non-interactive.
  • atlas-create-confluence-plugin-moduleatlas-create-confluence-plugin-module [options] – Prompts you for plugin module type and related details, then creates an example of a Confluence plugin module that you can adapt to suit your own plugin's needs. (Runs mvn confluence:create-plugin-module.) Passes all parameters straight through to Maven.
  • atlas-create-crowd-pluginatlas-create-crowd-plugin [options] – Creates an example of a Crowd plugin, which you can adapt to suit your own plugin's needs. (Runs mvn crowd:create.) Interpreted parameters: artifact-id, group-id, version, package, non-interactive.
  • atlas-create-crowd-plugin-moduleatlas-create-crowd-plugin-module [options] – Prompts you for plugin module type and related details, then creates an example of a Crowd plugin module that you can adapt to suit your own plugin's needs. (Runs mvn crowd:create-plugin-module.) Passes all parameters straight through to Maven.
  • atlas-create-fecru-pluginatlas-create-fecru-plugin [options] – Creates an example of a FishEye or Crucible plugin, which you can adapt to suit your own plugin's needs. (Runs mvn fecru:create.) Interpreted parameters: artifact-id, group-id, version, package, non-interactive.
  • atlas-create-fecru-plugin-moduleatlas-create-fecru-plugin-module [options] – Prompts you for plugin module type and related details, then creates an example of a FishEye/Crucible plugin module that you can adapt to suit your own plugin's needs. (Runs mvn fecru:create-plugin-module.) Passes all parameters straight through to Maven.
  • atlas-create-home-zipatlas-create-home-zip – Creates a test-resources zip of the current application's home directory. This zip file can then be pointed to in the AMPS productDataPath property to auto-populate application data during startup.
  • atlas-create-jira-pluginatlas-create-jira-plugin [options] – Creates an example of a JIRA plugin, which you can adapt to suit your own plugin's needs. (Runs mvn jira:create.) Interpreted parameters: artifact-id, group-id, version, package, non-interactive.
  • atlas-create-jira-plugin-moduleatlas-create-jira-plugin-module [options] – Prompts you for plugin module type and related details, then creates an example of a JIRA plugin module that you can adapt to suit your own plugin's needs. (Runs mvn jira:create-plugin-module.) Passes all parameters straight through to Maven.
  • atlas-create-refapp-pluginatlas-create-refapp-plugin [options] – Creates an example of a RefApp plugin, which you can adapt to suit your own plugin's needs. (Runs mvn refapp:create.) Interpreted parameters: artifact-id, group-id, version, package, non-interactive.
  • atlas-create-refapp-plugin-moduleatlas-create-refapp-plugin-module [options] – Prompts you for plugin module type and related details, then creates an example of a plugin module for the RefApp that you can adapt to suit your own plugin's needs. (Runs mvn refapp:create-plugin-module.) Passes all parameters straight through to Maven.
  • atlas-debugatlas-debug [options] – Runs the application in debug mode with your plugin installed. (Runs mvn amps:debug.) Interpreted parameters: version, container, http-port, context-path, server, jvmargs, log4j, test-version, sal-version, rest-version, plugins, lib-plugins, bundled-plugins, product, jvm-debug-port, jvm-debug-suspend.
  • atlas-helpatlas-help [--verbose] – Displays help text for the shell scripts incorporated into the Atlassian Plugin SDK. Interpreted parameters: verbose.
  • atlas-install-pluginatlas-install-plugin [options] – Installs the plugin into a running application. (Runs mvn amps:install.) Interpreted parameters: http-port, context-path, server, username, password, plugin-key.
  • atlas-integration-testatlas-integration-test [options] – Runs the integration tests for the plugin. (Runs mvn integration-test.) Interpreted parameters: version, container, http-port, context-path, server, jvmargs, log4j, test-version, sal-version, rest-version, plugins,lib-plugins, bundled-plugins, product, no-webapp, skip-tests.
  • atlas-mvnatlas-mvn [options] – Allows you to execute any Maven command using the version of Maven bundled with your Atlassian Plugin SDK. (Runs mvn.) Passes all parameters straight through to Maven.
  • atlas-packageatlas-package[options] – Packages the plugin artifacts and produces the JAR. (Runs mvn package.) Passes all parameters straight through to Maven.
  • atlas-releaseatlas-release [options] – Performs a release of the current plugin. (Runs mvn release:prepare release:perform.) Passes all parameters straight through to Maven.
  • atlas-release-rollbackatlas-release-rollback [options] – Rolls back a release of the current plugin. (Runs mvn release:rollback.) Passes all parameters straight through to Maven.
  • atlas-runatlas-run [options] – Runs the application with your plugin installed. (Runs mvn amps:run.) Interpreted parameters: version, container, http-port, context-path, server, jvmargs, log4j, test-version, sal-version, rest-version, plugins, lib-plugins, bundled-plugins, product.
  • atlas-run-cloudatlas-run-cloud [options] – Runs an Atlassian application with Connect and the Cloud dependencies installed. Interpreted parameters: application, maven-plugin-version.
  • atlas-run-standaloneatlas-run-standalone [options] – Runs an Atlassian application standalone, without a plugin project (that is, not requiring atlas-create-<product>-plugin). Interpreted parameters: version, container, http-port, context-path, server, jvmargs, log4j, test-version, sal-version, rest-version, plugins, lib-plugins, bundled-plugins, product.
  • atlas-unit-testatlas-unit-test [options] – Runs the unit tests for your plugin. (Runs mvn test.) Passes all parameters straight through to Maven.
  • atlas-updateatlas-update [options] – Updates the Atlassian Plugin SDK.
  • atlas-versionatlas-version – Displays version and runtime information for the Atlassian Plugin SDK. (Runs mvn --version.)

Was this page helpful?
Powered by Confluence and Scroll Viewport