otty / apps
All apps/Forge CLI

Forge CLI

forge-cli

Command line interface for building and managing Atlassian Forge apps.

Runs as forge|macOS, Linux, Windows|developer.atlassian.com
Open form in Otty otty.toml

Command form

ai-draft · 5 tasks · 15 fields

Create, deploy and install Forge apps. Logs, variables, providers and tunnel are left out.

Opens the form; the finished command lands at your prompt, unrun
Run in Otty
otty gui forge-cli
Forge CLIExample values, fixed in this page — nothing here reaches a terminal
Basic
Verbose
--verbose
ParametersOnly these flags are editable in the form
Verbose
boolean
--verbose

forge create

Create an app

Create a Forge app from a template.

Create an appExample values, fixed in this page — nothing here reaches a terminal
Basic
App name
string
Template
string
Directory
string
TasksEach one presets the form for one job
Create
nametemplatedirectory
ParametersOnly these flags are editable in the form
App name
string · positional 0
Template
string
--template-t
Directory
string
--directory-d

forge deploy

Deploy

Deploy the app to an environment.

DeployExample values, fixed in this page — nothing here reaches a terminal
Basic
Environment*
string
TasksEach one presets the form for one job
Deploy
environment
ParametersOnly these flags are editable in the form
Environment
string
--environment-edevelopmentstagingproduction
Skip pre-deployment checks
boolean
--no-verify-f
Non-interactive
boolean
--non-interactive

forge install

Install on a site

Install or upgrade the app on an Atlassian site.

Install on a siteExample values, fixed in this page — nothing here reaches a terminal
Basic
Environment*
string
Site URL*
string
Product*
string
TasksEach one presets the form for one job
Install
environmentsiteproduct
Upgrade
environmentsiteproductupgrade
ParametersOnly these flags are editable in the form
Environment
string
--environment-edevelopmentstagingproduction
Site URL
For example example.atlassian.net.
string
--site-s
Product
string
--product-pJiraConfluenceCompass
Upgrade existing
boolean
--upgrade
Skip scope confirmation
boolean
--confirm-scopes
Non-interactive
boolean
--non-interactive

forge lint

Lint

Check the source files for common errors.

LintExample values, fixed in this page — nothing here reaches a terminal
Basic
Environment
string
TasksEach one presets the form for one job
Lint
environment
ParametersOnly these flags are editable in the form
Fix automatically
boolean
--fix
Environment
string
--environment-edevelopmentstagingproduction
SourcesEvery flag above is checked against these
fig
completion

github.com

fig
completion

github.com

fig
completion

github.com

fig
completion

github.com

fig
completion

github.com

Before it fills your prompt, Otty checks the installed forge against its version. A form that does not match your version is not offered.