Install the Atlassian SDK on a Windows system

Before we dive into creating a plugin, you'll need to configure a local development environment so you can use the Atlassian SDK.

Note: these instructions are for Windows 10.

Step1. Set JAVA_HOME and update Path variables

The JAVA_HOME environment variable specifies the location of the JDK on your system. You can reference either Java SE Development Kit (JDK) 8 or AdoptOpenJDK 8. For Windows users, the default directory is C:\Program Files\Java\jdk1.8.x_y , where x_y is the Java JDK 8 version you have installed*. *

To set these environment variables:

1. Browse to the C:\Program Files\Java\jdk1.8.x_y folder on your system and copy the path to the folder.

2. Open Control Panel > System>Advanced System Settings.

3. On the Advanced tab click Environment Variables.

4. Locate the System variables section and click New.

5. Enter JAVA_HOME in the Variable name field and paste the folder path you copied into the Variable value field.

6. Click OK to close the dialog.

7. Click on Path variable in the **System variables ** section and click Edit.

8. Click **New **and type %JAVA_HOME%\bin in the available space.

9. Close all dialog windows.

10. Open a new  Command Prompt window, and run the following command:

    1
    2
    C:\Users\manthony>javac -version
    javac 1.8.0_91
    

     verify that your output is similar to what appears above.

Step 2. Install the SDK

1. Download a TGZ (GZipped tar file) of the SDK
2. Locate the downloaded SDK file.
3. Extract the file to your local directory by right clicking on the file and selecting Extract All from the menu.
4. Move the extracted directory to your C:\ drive

   1
   2
   move atlassian-public-sdk-9.1.1\atlassian-public-sdk-9.1.1 C:\atlassian-public-sdk-9.1.1
   

5. Open Control Panel > System>Advanced System Settings.
6. On the Advanced tab click Environment Variables.
7. Locate the System variables section and click New.
8. Enter ATLASSIAN_PLUGIN_SDK_HOME in the Variable name field and paste the folder path you copied to into the Variable value field.
9. Click OK to close the dialog.
10. Click on Path variable in the **System variables ** section and click Edit.
11. Click **New **and type %ATLASSIAN_PLUGIN_SDK_HOME%\bin in the available space.
12. Close all dialog windows.

Step 3. Verify the SDK is installed

Open a  Command Prompt window, and run the following command:

1
2
atlas-version

You should see something similar to:

1
2
ATLAS Version:    9.1.1
ATLAS Home:       C:\atlassian-plugin-sdk-9.1.1
ATLAS Scripts:    C:\atlassian-plugin-sdk-9.1.1\bin
ATLAS Maven Home: C:\atlassian-plugin-sdk-9.1.1\apache-maven-3.9.8
AMPS Version:     9.1.1
--------
Executing: "C:\atlassian-plugin-sdk-9.1.1\apache-maven-3.9.8\bin\mvn.cmd" --version -gs C:\atlassian-plugin-sdk-9.1.1\apache-maven-3.9.8/conf/settings.xml
Apache Maven 3.9.8 (36645f6c9b5079805ea5009217e36f2cffd34256)
Maven home: C:\atlassian-plugin-sdk-9.1.1\apache-maven-3.9.8
Java version: 1.8.0_91, vendor: Oracle Corporation
Java home: C:\Program Files\Java\jdk1.8.0_91\jre
Default locale: en_AU, platform encoding: Cp1252
OS name: "windows 10", version: "10.0", arch: "amd64", family: "dos"

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