id = "forge-cli"
name = "Forge CLI"
description = "Command line interface for building and managing Atlassian Forge apps."
homepage = "https://developer.atlassian.com/platform/forge/"
executables = ["forge"]

[commands]
format = 1
label = "Forge CLI"
description = "Create, deploy and install Forge apps. Logs, variables, providers and tunnel are left out."
quality = "ai-draft"
base = "fig:@forge/cli"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false }

[[commands.source]]
id = "fig"
kind = "completion"
url = "https://github.com/withfig/autocomplete/blob/master/src/@forge/cli.ts"
license = "MIT"

[[commands.field]]
id = "verbose"
label = "Verbose"
type = "boolean"
option = ["--verbose"]
sources = ["fig"]

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["verbose"]

[[commands.subcommand]]
path = ["create"]
label = "Create an app"
description = "Create a Forge app from a template."

[[commands.subcommand.source]]
id = "fig"
kind = "completion"
url = "https://github.com/withfig/autocomplete/blob/master/src/@forge/cli.ts"
license = "MIT"

[[commands.subcommand.field]]
id = "name"
label = "App name"
type = "string"
position = 0
sources = ["fig"]

[[commands.subcommand.field]]
id = "template"
label = "Template"
type = "string"
option = ["--template", "-t"]
sources = ["fig"]

[[commands.subcommand.field]]
id = "directory"
label = "Directory"
type = "string"
option = ["--directory", "-d"]
sources = ["fig"]

[[commands.subcommand.task]]
id = "create"
label = "Create"
fields = ["name", "template", "directory"]
required = []

[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["name", "template", "directory"]

[[commands.subcommand]]
path = ["deploy"]
label = "Deploy"
description = "Deploy the app to an environment."

[[commands.subcommand.source]]
id = "fig"
kind = "completion"
url = "https://github.com/withfig/autocomplete/blob/master/src/@forge/cli.ts"
license = "MIT"

[[commands.subcommand.field]]
id = "environment"
label = "Environment"
type = "string"
option = ["--environment", "-e"]
suggestions = [{ value = "development", label = "development" }, { value = "staging", label = "staging" }, { value = "production", label = "production" }]
sources = ["fig"]

[[commands.subcommand.field]]
id = "no_verify"
label = "Skip pre-deployment checks"
type = "boolean"
option = ["--no-verify", "-f"]
sources = ["fig"]

[[commands.subcommand.field]]
id = "non_interactive"
label = "Non-interactive"
type = "boolean"
option = ["--non-interactive"]
sources = ["fig"]

[[commands.subcommand.task]]
id = "deploy"
label = "Deploy"
fields = ["environment"]
required = ["environment"]

[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["environment"]

[[commands.subcommand.group]]
id = "advanced"
label = "Advanced"
fields = ["no_verify", "non_interactive"]

[[commands.subcommand]]
path = ["install"]
label = "Install on a site"
description = "Install or upgrade the app on an Atlassian site."

[[commands.subcommand.source]]
id = "fig"
kind = "completion"
url = "https://github.com/withfig/autocomplete/blob/master/src/@forge/cli.ts"
license = "MIT"

[[commands.subcommand.field]]
id = "environment"
label = "Environment"
type = "string"
option = ["--environment", "-e"]
suggestions = [{ value = "development", label = "development" }, { value = "staging", label = "staging" }, { value = "production", label = "production" }]
sources = ["fig"]

[[commands.subcommand.field]]
id = "site"
label = "Site URL"
description = "For example example.atlassian.net."
type = "string"
option = ["--site", "-s"]
sources = ["fig"]

[[commands.subcommand.field]]
id = "product"
label = "Product"
type = "string"
option = ["--product", "-p"]
suggestions = [{ value = "Jira", label = "Jira" }, { value = "Confluence", label = "Confluence" }, { value = "Compass", label = "Compass" }]
sources = ["fig"]

[[commands.subcommand.field]]
id = "upgrade"
label = "Upgrade existing"
type = "boolean"
option = ["--upgrade"]
sources = ["fig"]

[[commands.subcommand.field]]
id = "confirm_scopes"
label = "Skip scope confirmation"
type = "boolean"
option = ["--confirm-scopes"]
sources = ["fig"]

[[commands.subcommand.field]]
id = "non_interactive"
label = "Non-interactive"
type = "boolean"
option = ["--non-interactive"]
sources = ["fig"]

[[commands.subcommand.task]]
id = "install"
label = "Install"
fields = ["environment", "site", "product"]
required = ["environment", "site", "product"]

[[commands.subcommand.task]]
id = "upgrade"
label = "Upgrade"
fields = ["environment", "site", "product", "upgrade"]
required = ["environment", "site", "product"]
set = { upgrade = [true] }

[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["environment", "site", "product", "upgrade"]

[[commands.subcommand.group]]
id = "advanced"
label = "Advanced"
fields = ["confirm_scopes", "non_interactive"]

[[commands.subcommand]]
path = ["lint"]
label = "Lint"
description = "Check the source files for common errors."

[[commands.subcommand.source]]
id = "fig"
kind = "completion"
url = "https://github.com/withfig/autocomplete/blob/master/src/@forge/cli.ts"
license = "MIT"

[[commands.subcommand.field]]
id = "fix"
label = "Fix automatically"
type = "boolean"
option = ["--fix"]
effect = "overwrite"
sources = ["fig"]

[[commands.subcommand.field]]
id = "environment"
label = "Environment"
type = "string"
option = ["--environment", "-e"]
suggestions = [{ value = "development", label = "development" }, { value = "staging", label = "staging" }, { value = "production", label = "production" }]
sources = ["fig"]

[[commands.subcommand.task]]
id = "lint"
label = "Lint"
fields = ["environment"]
required = []

[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["fix", "environment"]