To start using Forge, you’ll have to create an Atlassian developer site, install the Forge CLI, and log in
with an Atlassian API token.
Before you begin
Read and understand the limitations
Make sure you read and understand the Beta limitations before starting development.
Install and configure the required software
To complete this tutorial, you need to install the following.
Node.js (a Node 12 version from 12.12.0 or later). Installing Node.js also installs npm.
Important: We recommend running Node under your user. If you're running node under root privilege instead,
you'll need to update the Node configuration to allow global module installs using binaries by running:
npm config set unsafe-perm true
To check your Node version, run the following in the terminal:
To update your Node version, we recommend using the Node Version Manager (nvm):
Python (a Python 2 version from 2.6.0 or later). The CLI is not compatible with Python 3.
To check your setup, run the following in terminal:
If the output is a Python 2 version later than 2.6.0, then your setup is correct. If not, you need to set the variable
PYTHON with the path to your python installation when you run the command to install the CLI. For example, if the
path is python2.6 then you install the CLI by running: