Last updated Aug 5, 2025

Forge Cheat Sheet

Download printable PDF version

Install Forge

Description Prerequisites Command
Install the Forge CLI

Installs the forge/cli package on your system using npm.

Ensure Node.js verison 20.x or 22.x is installed before you begin. npm install -g @forge/cli
Login to the Forge CLI

Log in to your Atlassian account so you can start building on the forge platform.

Generate an Atlassian API token via the Security tab of your Atlassian account. forge login

The Development Lifecycle

Description Command
Create a new App

Create a new app based on a selected template and registers to your account

forge create
Deploy app to the cloud

Deploy changes to your app to the cloud

forge deploy
Install your app to a cloud site

Install your app to an Atlassian cloud site.

forge install
Upgrade your app on a cloud site

Upgrade an existing installation

forge install --upgrade
Start the forge development tunnel

Start a development tunnel, allowing you to test local changes.

forge tunnel

Test, Debug and Troubleshoot

Description Command
Manage storage

Manage the storage for your app

forge storage
View Logs

View the application logs

forge logs
Check Code

Checks the source for common errors

forge lint
Check and Fix Code

Check for common errors and attempt to fix automatically.

forge lint --fix
Eligibility

Check app is eligible for a particular program

forge eligibility

Other useful commands

Description Command
Register

Register an app to your Atlassian Developer account

forge register
Environment Variables

Manage your appps environment variables

forge variables [list|set|unset]
Environments

Manage app environments

forge environments [list|create|delete]
Install Forge autocomplete

Install autocomplete for the Forge CLI

forge autocomplete install
Help

Display help for the forge CLI

forge help

Rate this page: