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.

Step 1: Configure your environment

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

1
2
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

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).

   1
   2
   host:~ test$ vi ~/.bash_profile
   

2. Add the following lines at the end of the file:

   1
   2
   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.

   You can choose to setup your machine to quickly change between different java versions by following the instructions here

3. Save and close the file.

4. Enter the following at the command line to pick up your changes:

   1
   2
   host:~ test$ source ~/.bash_profile
   

5. Verify you are now seeing the correct result when you enter the command javac -version in terminal

   1
   2
   host:~ test$ javac -version
   javac 1.8.0_91 
   

Step 2: Download and install the SDK

There is homebrew installer for Mac OSX, as well as a TGZ (GZipped tar file) which can be used for manual installation on Windows / Mac OS / Linux operating systems.  

Select the installation instructions that best suit you

Mac OSX

Homebrew

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

   1
   2
   brew tap atlassian/tap
   

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

   1
   2
   brew install atlassian/tap/atlassian-plugin-sdk
   

3. 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.

   1
   2
   sudo tar -xvzf atlassian-plugin-sdk-9.0.2.tar.gz -C /opt
   

4. Rename the extracted folder to  atlassian-plugin-sdk .

   1
   2
   sudo mv /opt/atlassian-plugin-sdk-9.0.2 /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:

1
2
atlas-version

You should see something similar to:

1
2
ATLAS Version:    9.0.2
ATLAS Home:       /opt/homebrew/Cellar/atlassian-plugin-sdk/9.0.2/libexec
ATLAS Scripts:    /opt/homebrew/Cellar/atlassian-plugin-sdk/9.0.2/libexec/bin
ATLAS Maven Home: /opt/homebrew/Cellar/atlassian-plugin-sdk/9.0.2/libexec/apache-maven-3.9.8
AMPS Version:     9.0.2
--------
Executing: /opt/homebrew/Cellar/atlassian-plugin-sdk/9.0.2/libexec/apache-maven-3.9.8/bin/mvn --version -gs /opt/homebrew/Cellar/atlassian-plugin-sdk/9.0.2/libexec/apache-maven-3.9.8/conf/settings.xml
Apache Maven 3.9.8 (36645f6c9b5079805ea5009217e36f2cffd34256)
Maven home: /opt/homebrew/Cellar/atlassian-plugin-sdk/9.0.2/libexec/apache-maven-3.9.8
Java version: 1.8.0_45, vendor: Oracle Corporation
Default locale: en_US, platform encoding: UTF-8
OS name: "mac os x", version: "14.5", arch: "x86_64", family: "mac"

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