Additional Requirements

  • All installations require version 1.8.x of the JDK. Please ensure this is installed first.
  • The Atlassian Plugin SDK does not support OpenJDK.

Use an installer

We recommend that you use one of our installers to get the Atlassian SDK onto your local development system. 

Just check your pre-requisites on Windows or Linux / Mac OS X, then download and run the installer appropriate for your operating system:

First time users

If you're installing the Atlassian SDK for the first time, you may want to follow the more detailed instructions. 

› Set up the Atlassian SDK and Build a Project


Other options

Installing from Package Managers

If you prefer you can use a suitable package manager for your OS 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 repositories:

    sudo sh -c 'echo "deb stable contrib" >>/etc/apt/sources.list'
  2. Add the public key:

    sudo apt-key adv --keyserver --recv-keys B07804338C015B73
  3. sudo apt-key fingerprint should include

    pub   2048R/8C015B73 2012-08-20
          Key fingerprint = 9465 19BB 719D 2C48 5D99  EC27 B078 0433 8C01 5B73
    uid                  Atlassian Package Signer <>
  4. And lastly, 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. Download the repo files to your /etc/yum.repos.d/ folder:

    cd /etc/yum.repos.d/
    sudo wget
  2. 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 can do that by downloading the version you want from Atlassian Marketplace.



  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:

    The Atlassian Marketplace contains only relatively recent version of the Atlassian Plugin SDK. If you need an older version than what is available on the Marketplace, you can get it from the Atlassian Maven repository.

  3. Once you have the package for the version you want, install it using the method appropriate for your OS. 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:




Was this page helpful?
Powered by Confluence and Scroll Viewport