Documentation

Class: Help

commands/help~ Help

Command class

new Help(app, config, util)

Create the service
Parameters:
Name Type Description
app App The application
config object Configuration
util Util Utility service

Members

<static> provides :string

Service name is 'commands.help'
Type:
  • string

<static> requires :Array.<string>

Dependencies as constructor arguments
Type:
  • Array.<string>

Methods

<async> run(argv)

Run the command
Parameters:
Name Type Description
argv Array.<string> Arguments
Returns:
Type
Promise

<async> usage()

General help
Returns:
Type
Promise

<async> helpHelp()

Help command
Returns:
Type
Promise

<async> helpInstall()

Install command
Returns:
Type
Promise

<async> helpInit()

Init command
Returns:
Type
Promise

<async> helpConfirm()

Confirm command
Returns:
Type
Promise

<async> helpRegister()

Register command
Returns:
Type
Promise

<async> helpUnregister()

Unregister command
Returns:
Type
Promise

<async> helpAuth()

Auth command
Returns:
Type
Promise

<async> helpCreate()

Create command
Returns:
Type
Promise

<async> helpDelete()

Delete command
Returns:
Type
Promise

<async> helpImport()

Import command
Returns:
Type
Promise

<async> helpAttach()

Attach command
Returns:
Type
Promise

<async> helpRattach()

Rattach command
Returns:
Type
Promise

<async> helpDetach()

Detach command
Returns:
Type
Promise

<async> helpRdetach()

Rdetach command
Returns:
Type
Promise

<async> helpTree()

Tree command
Returns:
Type
Promise

<async> helpConnections()

Connections command
Returns:
Type
Promise

<async> helpDaemons()

Daemons command
Returns:
Type
Promise

<async> helpLoad()

Load command
Returns:
Type
Promise

<async> helpRedeem()

Redeem command
Returns:
Type
Promise

<async> helpStart()

Start command
Returns:
Type
Promise

<async> helpStop()

Stop command
Returns:
Type
Promise

<async> helpRestart()

Restart command
Returns:
Type
Promise

<async> helpStatus()

Status command
Returns:
Type
Promise