The Forge Cheat Sheet is a reference to help you quickly identify and remember Forge CLI commands while you’re working through Forge Quest tutorials, workshops, training or when developing apps.
You can open this web page on your phone, or tablet - or print the PDF as a handy reference and make your own notes to go along with it.
You will also find information about useful Forge resources on the Getting Help page
Not sure where to start learning about building apps with Forge?
The Atlassian University Learning Path: Get the most out of Forge is a free course that will introduce you to the concepts you need to know to start building with Forge.
The Forge Quest tutorials provide self paced step by step guides for building apps with Forge to familiarise yourself with the basics, as well as taking you through more complex concepts like integrating with external systems, and storing and retrieving data with Forge.
Before you get started with Forge, you’ll need to set up your development environment. Stuck? See Preparing your forge toolkit for step by step instructions.
Prerequisites - Install Node 20 or 22, generate an API token via your Atlassian account.
| Description | Command |
|
Install the Forge CLI
Installs the forge/cli package on your system using npm. |
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. |
forge login
|
These commands are used throughout the application development lifecycle to create, test and deploy changes to your app, and install it to a cloud site. For more detailed information see the Forge CLI reference.
| 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
|
The below commands explain how the Forge CLI can be used to test, debug and troubleshoot via accessing the logs and storage, running automated code checks and testing for eligibility to programs like ‘runs on atlassian’. To learn more about any of these commands see the Forge CLI reference.
| 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
|
The below commands are useful from time to time, whether it’s to register an app to your account, manage and store environmental variables or configure the app environments to meet your specific needs. To learn more about any of these commands see the Forge CLI reference.
| 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: