The Atlassian Plugin SDK commands below allow you to create, build, customize, package and test Add-ons for Atlassian server products such as Jira, Confluence, Bitbucket and Bamboo.
To install the Atlassian Plugin SDK, see:
If you haven't used the Atlassian Plugin SDK before, you may wish to start with the tutorial: Set up the Atlassian SDK and build a project
Command | Example | Description |
---|---|---|
atlas-clean | atlas-clean [options] | Removes files from the project directory, that were generated during the build. Runs Passes all parameters straight through to Maven. |
atlas-cli | atlas-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 Interpreted parameters: |
atlas-clover | atlas-clover [options] | Runs unit and integration tests, generating a code coverage report with Clover. Passes all parameters straight through to Maven. Report is available in |
atlas-compile | atlas-compile [options] | Compiles the sources of your project. Runs Passes all parameters straight through to Maven. |
atlas-create-bamboo-plugin | atlas-create-bamboo-plugin [options] | Creates an example of a Bamboo plugin, which you can adapt to suit your own plugin's needs. Runs Interpreted parameters: |
atlas-create-bamboo-plugin-module | atlas-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 Passes all parameters straight through to Maven. |
atlas-create-bitbucket-plugin | atlas-create-bitbucket-plugin [options] | Creates an example of a Bitbucket plugin, which you can adapt to suit your own plugin's needs. Runs Interpreted parameters: |
atlas-create-bitbucket-plugin-module | atlas-create-bitbucket-plugin-module [options] | Prompts you for plugin module type and related details, then creates an example of a Bitbucket plugin module that you can adapt to suit your own plugin's needs. Runs Passes all parameters straight through to Maven. |
atlas-create-confluence-plugin | atlas-create-confluence-plugin [options] | Creates an example of a Confluence plugin, which you can adapt to suit your own plugin's needs. Runs Interpreted parameters: |
atlas-create-confluence-plugin-module | atlas-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 Passes all parameters straight through to Maven. |
atlas-create-crowd-plugin | atlas-create-crowd-plugin [options] | Creates an example of a Crowd plugin, which you can adapt to suit your own plugin's needs. Runs Interpreted parameters: |
atlas-create-crowd-plugin-module | atlas-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 Passes all parameters straight through to Maven. |
atlas-create-fecru-plugin | atlas-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 Interpreted parameters: |
atlas-create-fecru-plugin-module | atlas-create-fecru-plugin-module [options] | Prompts you for plugin module type and related details, then creates an example of a Fecru plugin module that you can adapt to suit your own plugin's needs. Runs Passes all parameters straight through to Maven. |
atlas-create-home-zip | atlas-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-plugin | atlas-create-jira-plugin [options] | Creates an example of a Jira plugin, which you can adapt to suit your own plugin's needs. Runs Interpreted parameters: |
atlas-create-jira-plugin-module | atlas-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 Passes all parameters straight through to Maven. |
atlas-create-refapp-plugin | atlas-create-refapp-plugin [options] | Creates an example of a RefApp plugin, which you can adapt to suit your own plugin's needs. Runs Interpreted parameters: |
atlas-create-refapp-plugin-module | atlas-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 Passes all parameters straight through to Maven. |
atlas-debug | atlas-debug [options] | Runs the application in debug mode with your plugin installed. Runs Interpreted parameters: |
atlas-help | atlas-help \[--verbose\] | Displays help text for the shell scripts incorporated into the Atlassian Plugin SDK. Interpreted parameters: |
atlas-install-plugin | atlas-install-plugin [options] | Installs the plugin into a running application. Runs Interpreted parameters: |
atlas-integration-test | atlas-integration-test [options] | Runs the integration tests for the plugin. Runs Interpreted parameters: |
atlas-mvn | atlas-mvn [options] | Allows you to execute any Maven command using the version of Maven bundled with your Atlassian Plugin SDK. Runs Passes all parameters straight through to Maven. |
atlas-package | atlas-package[options] | Packages the plugin artifacts and produces the JAR. Runs Passes all parameters straight through to Maven. |
atlas-release | atlas-release [options] | Performs a release of the current plugin. Runs Passes all parameters straight through to Maven. |
atlas-release-rollback | atlas-release-rollback [options] | Rolls back a release of the current plugin. Runs Passes all parameters straight through to Maven. |
atlas-run | atlas-run [options] | Runs the application with your plugin installed. Runs Interpreted parameters: |
atlas-run-standalone | atlas-run-standalone [options] | Runs an Atlassian application standalone, without a plugin project (that is, not requiring atlas-create-<product>-plugin) .Interpreted parameters: |
atlas-unit-test | atlas-unit-test [options] | Runs the unit tests for your plugin. Runs Passes all parameters straight through to Maven. |
atlas-update | atlas-update [options] | Updates the Atlassian Plugin SDK. |
atlas-version | atlas-version | Displays version and runtime information for the Atlassian Plugin SDK. Runs |
Found a bug with one of the above commands? You can report it at ecosystem.atlassian.net
Rate this page: