Install the Atlassian SDK on a Linux or Mac system

On this page, you install the SDK on your Linux or Mac system. You also configure your operating system to recognize the SDK commands in your environment.

On this page:

Not using Linux / Mac?

Windows users should see Install the Atlassian SDK on a Windows system

Step 1: Configure your environment

This assumes that you have the Java JDK1.8.x installed as described in Before you begin

Verify that you JAVA_HOME is set in your system by running echo $JAVA_HOME from the terminal

host:~ test$ echo $JAVA_HOME
/Library/Java/JavaVirtualMachines/jdk1.8.0_65.jdk/Contents/Home

If the output resembles the above skip ahead to Step 2: Download and Install the SDK

  Click here to configure your environment variables...

The JAVA_HOME environment variable specifies the location of the JDK on your system. On Mac OS X, if you accepted the defaults when you installed the JDK, this is /Library/Java/JavaVirtualMachines/1.8.0.jdk/Contents/Home. On Linux, it may be /usr/local/jdk, or a similar location. You should add the JDK's bin directory to your PATH environment variable as well. This ensures your environment is configured and can locate the javac command.

To set your PATH and JAVA_HOME variables:

  1. Edit the .bashrc file in your home directory using your favourite editor (we use vi in this example).

    host:~ test$ vi ~/.bash_profile
  2. Add the following lines at the end of the file:

    JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk1.8.0.0_91.jdk/Contents/Home
    export JAVA_HOME
    export PATH=$PATH:$JAVA_HOME/bin

    The path in Line 1 will be the path for the JDK on your system.

    For Mac OS X this is usually /Library/Java/JavaVirtualMachines/1.8.x.jdk. On Linux it may be /usr/local/jdk or similar.

  3. Save and close the file.
  4. Enter the following at the command line to pick up your changes:

    host:~ test$ source ~/.bash_profile
  5. Verify you are now seeing the correct result when you enter the command javac -version in terminal

    host:~ test$ javac -version
    javac 1.8.0_91 

Step 2: Download and install the SDK

There are native installers for a number of operating systems available, as well as a TGZ (GZipped tar file) which can be used for manual installation.  

Last updated 

By downloading and/or using this SDK you agree to the Atlassian Developer Terms

 

 

Select the installation instructions that best suit you:

Mac OSX

PKG File

  1. Download the PKG file.
  2. Double click the PKG file to launch the installer.
  3. Follow the prompts to complete the installation.
  4. Next: Verify that you have set up the SDK correctly

Homebrew

  1. Open a Terminal window and add the Atlassian "Tap" to your Brew using the command:

    brew tap atlassian/tap
  2. Then install the SDK via the atlassian/tap using the command:

    brew install atlassian/tap/atlassian-plugin-sdk
  3. Next: Verify that you have set up the SDK correctly

Debian, Ubuntu Linux

On a Debian based Linux like Ubuntu, you can install the Atlassian Plugin SDK using apt-get or aptitude, but first you have to set up the Atlassian repositories. You only need to do this once and it requires sudo privileges.

To set up the Atlassian repositories,

  1. Open a terminal window and enter the following:

    sudo sh -c 'echo "deb https://sdkrepo.atlassian.com/debian/ stable contrib" >>/etc/apt/sources.list'
  2. After the prompt returns, add the public key:

    sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys B07804338C015B73
  3. Once you have set up the Atlassian repositories, enter the following to install the SDK:

    sudo apt-get install apt-transport-https
    sudo apt-get update
    sudo apt-get install atlassian-plugin-sdk

    Note: You can use the same  apt  tools to upgrade the SDK to a new version when an update becomes available.

    The first command makes sure that you have     apt-transport-https  package installed to make     apt  be able to access https repositories.

  4. Next: Verify that you have set up the SDK correctly

Red Hat Enterprise Linux, CentOS, Fedora (RPM)

The instructions below use dnf to install the SDK. If you are on an older version you might not have dnf and should use yum instead.

All you should have to do to download the latest version of the SDK is:

sudo dnf install atlassian-plugin-sdk

If this does not work, try downloading and installing manually:

  1. Download the Atlassian Plugin SDK - RPM

  2. Then, open a Terminal window and start the installation:

    sudo dnf localinstall <PATH_TO_DOWNLOADED_FILE>

    remember that you will need to modify your path in the above example, it should be something like ~/Downloads/atlassian-plugin-sdk-6.2.9.noarch.rpm

As always, Next: Verify that you have set up the SDK correctly.

.tgz File

To install the latest version of SDK, do the following:

  1. Download a TGZ (GZipped tar file) of the SDK
  2. Locate the downloaded SDK file. 
  3. Extract the file to your local directory.

    sudo tar -xvzf atlassian-plugin-sdk-4.0.tar.gz -C /opt
  4. Rename the extracted folder to  atlassian-plugin-sdk .

    sudo mv /opt/atlassian-plugin-sdk-4.0 /opt/atlassian-plugin-sdk 

    If you are comfortable working with symbolic links, you can set up a symbolic link instead of renaming the directory.

  5. Next: Verify that you have set up the SDK correctly

Step 3: Verify that you have set up the SDK correctly

Open a terminal window and run the following command:

atlas-version

You should see something similar to:

ATLAS Version:    6.2.9
ATLAS Home:       /usr/local/Cellar/atlassian-plugin-sdk/6.2.4/libexec
ATLAS Scripts:    /usr/local/Cellar/atlassian-plugin-sdk/6.2.4/libexec/bin
ATLAS Maven Home: /usr/local/Cellar/atlassian-plugin-sdk/6.2.4/libexec/apache-maven-3.2.1
AMPS Version:     6.2.6
--------
Executing: /usr/local/Cellar/atlassian-plugin-sdk/6.2.4/libexec/apache-maven-3.2.1/bin/mvn --version -gs /usr/local/Cellar/atlassian-plugin-sdk/6.2.4/libexec/apache-maven-3.2.1/conf/settings.xml
Java HotSpot(TM) 64-Bit Server VM warning: ignoring option MaxPermSize=256M; support was removed in 8.0
Apache Maven 3.2.1 (ea8b2b07643dbb1b84b6d16e1f08391b666bc1e9; 2014-02-15T04:37:52+10:00)
Maven home: /usr/local/Cellar/atlassian-plugin-sdk/6.2.4/libexec/apache-maven-3.2.1
Java version: 1.8.0_45, vendor: Oracle Corporation
Java home: /Library/Java/JavaVirtualMachines/jdk1.8.0_45.jdk/Contents/Home/jre
Default locale: en_US, platform encoding: UTF-8
OS name: "mac os x", version: "10.11.6", arch: "x86_64", family: "mac"

Look for Maven home and note that you are running the version of Maven that is installed with the SDK.

Next step

You now have a local development environment configured for the Atlassian SDK and you're ready to build your first plugin!

Additional Resources

Need help? Request support at Developer Technical Support Portal

Was this page helpful?
Powered by Confluence and Scroll Viewport