Alert Logic CLI Interactive Help

This section describes the interactive help provided by the Alert Logic CLI. Using the Alert Logic CLI itself, you can easily look up supported commands, possible arguments, and examples.

Access help for the Alert Logic CLI

To access more information about the Alert Logic CLI itself, including supported commands, execute:

Copy

alcli help

Sample output:

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
ALCLI()                                                                  ALCLI()
NAME
	alcli -
DESCRIPTION
	The Alert Logic Command Line Interface is a tool to help you manage
	Alert Logic Services.
SYNOPSIS
	alcli [options] <command> <subcommand> [parameters]
	Use alcli command help for information on a  specific command.
OPTIONS
	--debug (boolean)
	Turn on debug logging.
	--query (string)
	A JMESPath query to use in filtering the response data.
:

Use the following commands to navigate the help:

Space: next page

Up-arrow: scroll up

Down-arrow: scroll down

q: exit

Executing Alert Logic CLI commands

Alert Logic CLI execution follows the general pattern

alcli [options] command subcommand [parameters]

The options control the general operation of the CLI, such as debugging or response queries using JMESPath. Commands correspond to Alert Logic service names, subcommands to individual APIs of that service, and parameters provide additional input to the given API.

To obtain a list of supported commands, execute:

alcli commands

alcli help

To obtain a list of supported subcommands for a given command, run:

alcli <command> help

For example:

Copy

alcli aims help

To obtain supported parameters, examples, and requirements for a given subcommand, run:

alcli <command> <subcommand> help

For example:

Copy

alcli aims authenticate help

This information is available in the Service Reference section as well.