This repository contains an outer folder to install and configure the Forge CLI with an inner folder containing the Jira app itself.
See developer.atlassian.com/platform/forge for documentation and tutorials explaining Forge.
See docs/decisions/README.md for decision records.
The following steps reflect the usual Getting started instructions but diverge for reproducability and portability reasons.
Forge CLI requires Docker and Node.js 20 (LTS) to be installed:
Forge recommend installing Node using using nvm but asdf also works. Ensure you are using the correct Node.js version before executing any other commands:
nvm use
Forge instructions start by installing the CLI globally but instead we will use a local installation with pinned requirements:
npm ci
The Forge CLI is then available by typing npx forge.
Create an Atlassian API token to log in to the CLI. The CLI uses your token when running commands.
- Go to https://id.atlassian.com/manage/api-tokens.
- Click Create API token.
- Enter a label to describe your API token. For example, forge-api-token.
- Click Create.
- Click Copy to clipboard and close the dialog.
The forge login command attempts to store credentials in your operating system keychain and may not work on all
platforms. Instead, we can skip this command and set environment variables instead.
Copy .env-example to .env and complete your Atlassian account email address and API token.
If you use direnv these values should be picked up automatically. Alternatively use the activate script:
source <(./bin/activate)
This reads .env values into your shell environment and also sets an alias so you can execute Forge CLI commands by
typing forge without needing an npx prefix or to or mess with your path variable.
Check installation and authentication by typing e.g.:
forge whoami
First change into the app folder:
cd flagsmith-jira-app