This page describes the shell script
atlas-create-confluence-plugin-module, part of the Atlassian Plugin SDK.
There is a specific version of this shell script for each Atlassian application. The shell script described on this page is for Confluence.
On this page:
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
mvn confluence:create-plugin-module.) Passes all parameters straight through to Maven.
The script will automatically add the changes to your
atlassian-plugin.xml and generate the appropriate Java code.
This shell script is a Maven wrapper script. All parameters are passed straight through to Maven.
Supported plugin module types
The plugin module generation scripts are still under development. Currently, only the JIRA script has the full set of modules. All other products contain the applicable common modules, such as REST, web item and servlet. See the list of common modules in the Atlassian Plugin Framework.
The shell script will display some help text if you enter one of the following as the first argument:
Let's assume you want to add a new plugin module to your existing Confluence plugin.
- Create your plugin (
atlas-create-confluence-plugin) and install it into the application (
atlas-run) as usual.
- Go to the root directory for your plugin (where the
- Run this command:
- Follow the prompts to specify the type of plugin module that you want, and further information required to create the basic module.
- The script will added the required module to your
- Where relevant, the script will add the Java classes to your plugin's .java file too.