Rate this page:
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.
This assumes that you have the Java SE Development Kit (JDK) 8 or AdoptOpenJDK 8 installed as described in Before you begin
Verify that you have JAVA_HOME 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
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
To set your
.bashrc file in your home directory using your favourite editor (we use vi in this example).
host:~ test$ vi ~/.bash_profile
Add the following lines at the end of the file:
JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk188.8.131.52_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.
You can choose to setup your machine to quickly change between different java versions by following the instructions here
Save and close the file.
Enter the following at the command line to pick up your changes:
host:~ test$ source ~/.bash_profile
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
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 04 Dec 2015
By downloading and/or using this SDK you agree to the Atlassian Developer Terms
Open a Terminal window and add the Atlassian "Tap" to your Brew using the command:
brew tap atlassian/tap
Then install the SDK using the atlassian/tap command:
brew install atlassian/tap/atlassian-plugin-sdk
On a Debian-based Linux system like Ubuntu, you can install the SDK using
First, set up the Atlassian SDK repositories:
sudo sh -c 'echo "deb https://packages.atlassian.com/debian/atlassian-sdk-deb/ stable contrib" >>/etc/apt/sources.list'
Download the public key using
Add the public key to
apt to verify the package signatures automatically:
sudo apt-key add public
Then, run the install:
sudo apt-get update sudo apt-get install atlassian-plugin-sdk
To install on systems that use the Yum package manager:
Create the repo file in your /etc/yum.repos.d/ folder:
sudo vi /etc/yum.repos.d/artifactory.repo
Configure the repository details:
[Artifactory] name=Artifactory baseurl=https://packages.atlassian.com/yum/atlassian-sdk-rpm/ enabled=1 gpgcheck=0
Install the SDK:
sudo yum clean all sudo yum updateinfo metadata sudo yum install atlassian-plugin-sdk
To install the latest version of SDK, do the following:
Locate the downloaded SDK file.
Extract the file to your local directory.
sudo tar -xvzf atlassian-plugin-sdk-4.0.tar.gz -C /opt
Rename the extracted folder to
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.
Open a terminal window and run the following command:
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"
Maven home and note that you are running the version of Maven that is installed with the SDK.
You now have a local development environment configured for the Atlassian SDK and you're ready to build your first plugin!
Need help? Request support at Developer Technical Support Portal
Rate this page: