Not using Linux / Mac?
Windows users should see Install the Atlassian SDK on a Windows 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.
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
1 2host:~ 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
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:
.bashrc
file in your home directory using your favourite editor (we use vi in this example).1 2host:~ test$ vi ~/.bash_profile
1 2JAVA_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.
You can choose to setup your machine to quickly change between different java versions by following the instructions here
1 2host:~ test$ source ~/.bash_profile
javac -version
in terminal1 2host:~ 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
PKG File
1 2brew tap atlassian/tap
1 2brew install atlassian/tap/atlassian-plugin-sdk
On a Debian-based Linux system like Ubuntu, you can install the SDK using apt-get
or aptitude
:
1 2sudo sh -c 'echo "deb https://packages.atlassian.com/debian/atlassian-sdk-deb/ stable contrib" >>/etc/apt/sources.list'
curl
or wget
:1 2wget https://packages.atlassian.com/api/gpg/key/public
apt
to verify the package signatures automatically:1 2sudo apt-key add public
1 2sudo apt-get update sudo apt-get install atlassian-plugin-sdk
To install on systems that use the Yum package manager:
1 2sudo vi /etc/yum.repos.d/artifactory.repo
1 2[Artifactory] name=Artifactory baseurl=https://packages.atlassian.com/yum/atlassian-sdk-rpm/ enabled=1 gpgcheck=0
1 2sudo yum clean all sudo yum updateinfo metadata sudo yum install atlassian-plugin-sdk
To install the latest version of SDK, do the following:
1 2sudo tar -xvzf atlassian-plugin-sdk-4.0.tar.gz -C /opt
atlassian-plugin-sdk
.1 2sudo 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:
1 2atlas-version
You should see something similar to:
1 2ATLAS 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.
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: