atlas-help

This page describes the shell script atlas-help, part of the Atlassian Plugin SDK.

On this page:

Basic Usage

atlas-help [--verbose] – Displays help text for the shell scripts incorporated into the Atlassian Plugin SDK. Interpreted parameters: verbose.

Parameters

Full Parameter

Shortened

Accepts a Value?

Description

--verbose

No

Lists all the shell scripts and the full help text for each command.

Examples and More about Getting Help

Help is at hand

Make sure you are not in the Maven command line interface (CLI) when you enter the help commands described below. If you are in the CLI, your command line will start with maven2>, and you will need to exit from the CLI first. Enter quit, exit or a friendly bye.

Getting an Overview of All the Scripts

Enter the following shell script to see an overview of all the scripts with a brief outline of their functionality:

atlas-help

Enter the following to see all possible help content:

atlas-help --verbose
Getting Help Text per Script

Each shell script provides help text if the first argument of the script is one of the following:

  • -?
  • -h
  • help
  • -help
  • --help

Examples:

atlas-clean help
atlas-cli -?
Reading the Reference Guide

See the detailed guide to all scripts.

RELATED TOPICS

Working with the SDK
Developing your Plugin using the Atlassian Plugin SDK

Was this page helpful?
Powered by Confluence and Scroll Viewport