atlas-run-cloud

The atlas-run-cloud command is no longer the supported method for developing a cloud add-on as per the blog Atlassian introduces new cloud development environment.

This page describes the shell script atlas-run-cloud, part of the Atlassian Plugin SDK (6.2.2 and later).

This command is used to start a local Cloud instance of an Atlassian application. It currently only works for JIRA Software. If you want to start a local instance of another application, or you want to start a local Server instance of JIRA Software, see atlas-run-standalone instead.

On this page:

Basic Usage

atlas-run-cloud [options] – Runs an Atlassian application with Connect and the Cloud dependencies installed. Interpreted parameters: application, maven-plugin-version.

Parameters

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.

Interpreted parameters:

Full Parameter

Shortened

Accepts a Value?

Description

--application

Yes

Application to run. Application will be run with current Cloud configuration. Valid values:

  • jira-software
--maven-plugin-version -u Yes

Maven AMPS plugin version to use. The default value depends on the version of the Atlassian plugin SDK. View the help text for atlas-run-cloud (see below) for details.

Getting Help

The shell script will display some help text if you enter one of the following as the first argument:

  • -?
  • -h
  • help
  • -help
  • --help

For example:

atlas-run-cloud -?
atlas-run-cloud -help

Examples

Say you want to quickly spin up an instance of JIRA Software with Connect and all of the Cloud dependencies installed. At the command line, type:

atlas-run-cloud --application jira-software

This will do the following:

  1. Download the latest pom defining the current Cloud production environment with JIRA Software, Atlassian Connect and other Cloud dependencies
  2. Create a directory called target in your current working directory, which will contain a JIRA home directory, database and server logs.
  3. Start up a JIRA Software instance. The output message from this command will tell you the URL where JIRA Software was started.
RELATED TOPICS

Working with the SDK

Was this page helpful?
Powered by Confluence and Scroll Viewport