org.apache.geode.management.cli (Apache Geode 1.5.0)
Date: 2018-03-30

# Package org.apache.geode.management.cli

The Command Line Interface (CLI) package provides a set of APIs for writing commands that can be used to manage and monitor GemFire components.

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  CommandStatement | Deprecated since Geode 1.3.
  ConverterHint | Used in `CliOption` annotations to indicate which converter(s) should or should not be used.
  Result | The result of processing a GemFire Command Line Interface (CLI) command string.

- Class Summary
  Class | Description
  --- | ---
  CommandService | Deprecated since 1.3 use OnlineCommandProcessor directly

- Enum Summary
  Enum | Description
  --- | ---
  Result.Status | Indicates a Results status.

- Exception Summary
  Exception | Description
  --- | ---
  CommandProcessingException | Indicates that an exception occurred while processing a GemFire Command Line Interface (CLI) command.
  CommandServiceException | Indicates that an exception occurred while accessing/creating a Command Service for processing GemFire Command Line Interface (CLI) commands.

- Annotation Types Summary
  Annotation Type | Description
  --- | ---
  CliMetaData | An annotation to define additional meta-data for commands.
  CliMetaData.AvailabilityMetadata | Deprecated since Geode1.2, not used at all

## Package org.apache.geode.management.cli Description

The Command Line Interface (CLI) package provides a set of APIs for writing commands that can be used to manage and monitor GemFire components. This interface is currently used by the GemFire SHell (GFSH) command line utility, but may be used to create custom commands which build upon that functionality.