Forge CLI
Command line interface (CLI) to help create, manage, and deploy Forge apps.
See developer.atlassian.com/platform/forge/ for documentation and tutorials explaining Forge.
Requirements
You need the following:
- Node.js: The Forge CLI requires an LTS version of Node JS installed. We recommend that you install Node JS via Node version manager.
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:
node --version
See Getting started for instructions to get set up.
Installation
Install the CLI globally by running:
npm install -g @forge/cli
Get started
Explore the help by running:
forge --help
This displays the list of available commands:
Usage: forge [options] [command]
Options:
--version output the version number
--verbose enable verbose mode
-h, --help output usage information
Quick Start
login [options] log in to your Atlassian account
create [options] [name] create an app
deploy [options] deploy your app to an environment
install [options] manage app installations
tunnel [options] start a tunnel to connect your local code with the app
running in the development environment
Develop
build [options] build and upload your app
lint [options] check the source files for common errors
logs [options] view app logs
Manage
register [options] [name] register an app you didn't create so you can run commands
for it
developer-spaces [options] manage Developer Spaces
uninstall [options] uninstall the app from an Atlassian site
environments [options] manage app environments
variables [options] manage app environment variables
webtrigger [options] manage webtriggers
settings [options] manage Forge CLI settings
providers [options] manage external providers
storage [options] manage storage for your app
eligibility [options] check if your app is eligible for certain programs like
Runs on Atlassian
version [options] app version information
custom-scopes [options] manage custom scopes
Account
logout [options] log out of your Atlassian account
whoami [options] display the account information of the logged in user
CLI Experience
autocomplete [options] [install|uninstall] configures autocomplete for the Forge CLI
feedback [options] let us know what you think about Forge
assistant [options] [⚠️ experimental feature] manage AI assistant settings
(Rovo/Gemini)
Support
See Get help for how to get help and provide feedback.