@forge/cli
A command line interface for managing Atlassian-hosted apps
Last updated 14 days ago by atlassian-cicd .
UNLICENSED · Repository · Original npm · Tarball · package.json
$ cnpm install @forge/cli 
SYNC missed versions from official npm registry.

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 (version 10.0.0 or later). Installing Node.js also installs npm.

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
  • Docker (version 17.03 or later).

To check your Docker version, run the following in the terminal:

docker --version

See Set up Forge 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

Commands:
  login [options]                        log in to your Atlassian account
  logout [options]                       log out of your Atlassian account
  login:ci [options]                     create a new authentication token for non-interactive environments
  whoami [options]                       display the account information of the logged in user
  create [options] [name]                create an app
  register [options] [name]              register an app you didn't create so you can run commands for it
  deploy [options]                       deploy your app to an environment
  install [options]                      install the app on an Atlassian site
  install:list [options]                 list app installations
  uninstall [options] [installationId]   uninstall the app from an Atlassian site
  variables:set [options] [key] [value]  set an environment variable
  variables:unset [options] <key>        remove an environment variable
  variables:list [options]               list the environment variables
  logs [options]                         view app logs
  tunnel [options]                       start a tunnel to connect your local code with the app running in an environment
  webtrigger [options] [installationId]  get a web trigger URL

Support

See Get help for how to get help and provide feedback.

Current Tags

106 Versions

  • 0.13.1-next.8                                ...           2 hours ago
  • 0.13.1-next.2                                ...           11 days ago
  • 0.13.0                                ...           14 days ago
  • 0.13.0-next.2                                ...           17 days ago
  • 0.12.0                                ...           a month ago
  • 0.0.0-experimental-56e9ae8                                ...           a month ago
  • 0.11.1-next.4                                ...           a month ago
  • 0.0.0-experimental-b690b68                                ...           a month ago
  • 0.0.0-experimental-f83134d                                ...           a month ago
  • 0.0.0-experimental-1a64864                                ...           a month ago
  • 0.0.0-experimental-5db9029                                ...           a month ago
  • 0.0.0-experimental-24f6ac8677d52a91e787a5e03726b5e96ce5e12c                                ...           a month ago
  • 0.11.1-next.1                                ...           a month ago
  • 0.12.0-next.0                                ...           a month ago
  • 0.11.0                                ...           2 months ago
  • 0.10.1-next.3                                ...           2 months ago
  • 0.10.1-next.2                                ...           2 months ago
  • 0.11.0-next.1                                ...           2 months ago
  • 0.11.0-next.0                                ...           2 months ago
  • 0.10.0                                ...           2 months ago
  • 0.9.1-next.6                                ...           2 months ago
  • 0.9.1-next.5                                ...           2 months ago
  • 0.10.0-next.4                                ...           2 months ago
  • 0.10.0-next.3                                ...           2 months ago
  • 0.10.0-next.2                                ...           2 months ago
  • 0.10.0-next.1                                ...           2 months ago
  • 0.10.0-next.0                                ...           3 months ago
  • 0.9.0                                ...           3 months ago
  • 0.9.0-next.30                                ...           3 months ago
  • 0.9.0-next.29                                ...           3 months ago
  • 0.8.1-next.28                                ...           3 months ago
  • 0.9.0-next.27                                ...           3 months ago
  • 0.9.0-next.26                                ...           3 months ago
  • 0.9.0-next.25                                ...           3 months ago
  • 0.9.0-next.24                                ...           3 months ago
  • 0.9.0-next.23                                ...           3 months ago
  • 0.9.0-next.22                                ...           3 months ago
  • 0.9.0-next.21                                ...           3 months ago
  • 0.9.0-next.20                                ...           3 months ago
  • 0.8.0-next.19                                ...           3 months ago
  • 0.8.0-next.18                                ...           3 months ago
  • 0.8.0-next.17                                ...           3 months ago
  • 0.8.0-next.16                                ...           3 months ago
  • 0.8.0-next.15                                ...           3 months ago
  • 0.8.0-next.13                                ...           3 months ago
  • 0.8.0-next.12                                ...           3 months ago
  • 0.8.0-next.11                                ...           3 months ago
  • 0.8.0-next.9                                ...           3 months ago
  • 0.8.0-next.8                                ...           3 months ago
  • 0.8.0-next.7                                ...           3 months ago
  • 0.8.0-next.6                                ...           3 months ago
  • 0.8.0-next.5                                ...           3 months ago
  • 0.8.0-next.4                                ...           4 months ago
  • 0.8.0-next.3                                ...           4 months ago
  • 0.8.0                                ...           4 months ago
  • 0.8.0-next.2                                ...           4 months ago
  • 0.8.0-next.1                                ...           4 months ago
  • 0.8.0-next.0                                ...           4 months ago
  • 0.7.1                                ...           4 months ago
  • 0.6.4                                ...           5 months ago
  • 0.6.3                                ...           5 months ago
  • 0.6.2                                ...           5 months ago
  • 0.6.1                                ...           5 months ago
  • 0.6.0                                ...           5 months ago
  • 0.5.0                                ...           5 months ago
  • 0.4.0                                ...           6 months ago
  • 0.3.0                                ...           6 months ago
  • 0.2.0                                ...           6 months ago
  • 0.1.1                                ...           6 months ago
  • 0.1.0                                ...           6 months ago
  • 0.0.39                                ...           6 months ago
  • 0.0.38                                ...           6 months ago
  • 0.0.37                                ...           6 months ago
  • 0.0.36                                ...           6 months ago
  • 0.0.35                                ...           6 months ago
  • 0.0.34                                ...           6 months ago
  • 0.0.33                                ...           6 months ago
  • 0.0.32                                ...           6 months ago
  • 0.0.31                                ...           6 months ago
  • 0.0.30                                ...           6 months ago
  • 0.0.29                                ...           6 months ago
  • 0.0.28                                ...           6 months ago
  • 0.0.27                                ...           6 months ago
  • 0.0.26                                ...           6 months ago
  • 0.0.25                                ...           6 months ago
  • 0.0.24                                ...           6 months ago
  • 0.0.23                                ...           6 months ago
  • 0.0.22                                ...           6 months ago
  • 0.0.21                                ...           6 months ago
  • 0.0.20                                ...           6 months ago
  • 0.0.19                                ...           6 months ago
  • 0.0.18                                ...           6 months ago
  • 0.0.17                                ...           6 months ago
  • 0.0.16                                ...           6 months ago
  • 0.0.15                                ...           6 months ago
  • 0.0.14                                ...           6 months ago
  • 0.0.13                                ...           6 months ago
  • 0.0.12                                ...           6 months ago
  • 0.0.11                                ...           6 months ago
  • 0.0.10                                ...           6 months ago
  • 0.0.9                                ...           6 months ago
  • 0.0.8                                ...           6 months ago
  • 0.0.6                                ...           6 months ago
  • 0.0.5                                ...           6 months ago
  • 0.0.4                                ...           6 months ago
  • 0.0.2                                ...           6 months ago
Downloads
Today 36
This Week 36
This Month 304
Last Day 105
Last Week 107
Last Month 370
Dependencies (22)
Dev Dependencies (19)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |