Atlassian SDK Developer

Atlassian SDK Developer

Last updatedMay 22, 2020

Rate this page:


Before you begin

Last updated 04 Dec 2015 By downloading and/or using this SDK you agree to the Atlassian Developer Terms

To install the Atlassian Plugin SDK, you'll also need the following:

  • Java SE Development Kit (JDK) 8 or AdoptOpenJDK 8
  • Your JAVA_HOME variable set

A note on OpenJDK

The Atlassian Plugin SDK currently supports AdoptOpenJDK 8 only.

First time users

If you're installing the Atlassian SDK for the first time, you can find detailed instructions for setting your JAVA_HOME, downloading and installing the Atlassian Plugin SDK and creating your first project. 

› Set up the Atlassian SDK and Build a Project

Download the installer

For Windows and macOS users, you can download the latest version of the installer via Atlassian Marketplace:

Installing from Package Managers

If you prefer you can use a suitable package manager for your operating system to install the Atlassian SDK. 

If you previously installed the SDK using tar.gz and added the SDK folder to your PATH, you'll need to remove it from your PATH before starting.

Debian / Ubuntu Linux

On a Debian-based Linux system like Ubuntu, you can install the SDK using apt-get or aptitude:

  1. First, set up the Atlassian SDK repositories:

    sudo sh -c 'echo "deb stable contrib" >>/etc/apt/sources.list'
  2. Download the public key using curl or wget:

  3. Add the public key to apt to verify the package signatures automatically:

    sudo apt-key add public   
  4. Then, run the install:

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

RPM / RHEL / CentOS / Fedora (Yum)

To install on systems that use the Yum package manager:

  1. Create the repo file in your /etc/yum.repos.d/ folder:

    sudo vi /etc/yum.repos.d/artifactory.repo
  2. Configure the repository details:

  3. Install the SDK:

    sudo yum clean all
    sudo yum updateinfo metadata
    sudo yum install atlassian-plugin-sdk

Homebrew (OS X)

As of 4.0, a pkg installer is available for OSX. It installs the SDK in /usr/share and adds links for the atlas commands into /usr/local/bin. An script is also provided in /usr/share/atlassian-plugin-sdk-N.N

Alternatively Homebrew (aka, Brew) is an open source package manager for OS X and is an alternative to MacPorts. You can learn more about Homebrew and how to it install it at

To install the Atlassian Plugin SDK in Brew:

  1. Add the Atlassian "Tap" to your Brew:

    brew tap atlassian/tap
  2. Next, install the SDK via the atlassian/tap:

    brew install atlassian/tap/atlassian-plugin-sdk

This installs the SDK. Later, if you want to upgrade the SDK to a new version, use:

brew update
brew upgrade atlassian/tap/atlassian-plugin-sdk

Installing an earlier version of the SDK

If you need to install an earlier version of the SDK for any reason, you will find it on the Atlassian Marketplace.

The Atlassian Marketplace contains versions of the Atlassian Plugin SDK after 4.0. If you need an older version than what is available on the Marketplace, you can get it from the Atlassian Public Maven repository.

  1. Remove an existing install, if necessary, using the method appropriate for your operating system. For example, for Debian / Ubuntu Linux, enter the command:

    sudo apt-get --purge remove atlassian-plugin-sdk
  2. Download the version you want from the Atlassian Marketplace:

  3. Once you have the package for the version you want, install it using the method appropriate for your operating system. For example, for Debian / Ubuntu Linux, use:

    sudo dpkg -i package_name

    Where package_name is the name of the file you downloaded. For example:

    sudo dpkg -i atlassian-plugin-sdk_4.1.5_all.deb
  4. The PATH isn't set automatically, so add the bin directory to your PATH manually, say in etc/environment:


Rate this page: