│ Grooper Help - Version 25.0
25.0.0017 2,127
  • Overview
  • Help Status

help

Display help for GCC command groups and commands.

Remarks

The help command group provides interactive assistance for using the Grooper Command Console (GCC). Use these commands to discover available command groups, explore the commands within each group, and view detailed usage information for any specific command.

With the help group, you can quickly list all command groups in GCC, see summaries of the commands in a group, or get comprehensive details about a particular command's syntax, parameters, and usage.

The help group is designed to make it easy to learn about GCC's capabilities and to find the right command for your task, all from the command line. Use these commands to get oriented, troubleshoot syntax, or understand the options available for any operation in GCC.

Commands

Below are the commands in this group

list

Displays a list of all available GCC command groups.

Use this command to view a summary of all command groups available in the Grooper Command Console (GCC). Each group represents a set of related commands for managing or interacting with Grooper.

Examples:

  1. List all command groups:
    gcc help

  2. List all command groups using the explicit 'list' command:
    gcc help list

Notes:

  • The output includes the group name and a brief description.
  • To see commands within a group, use gcc help <group>.

list <group>

Displays help for all commands in a specific command group.

Use this command to view a list of all commands available within a specific command group. This is helpful for discovering the available actions and their summaries for a particular area of Grooper functionality.

Examples:

  1. List all commands in the 'connections' group:
    gcc help connections

  2. List all commands in the 'databases' group:
    gcc help databases

Notes:

  • The output includes the command signatures and brief summaries.
  • To see detailed help for a specific command, use gcc help <group> <command>.

group

The name of the command group to display help for. Provide the group name as shown in the list of command groups (e.g., 'connections', 'databases').

list <group> <command>

Displays detailed help for a specific command in a command group.

Use this command to view comprehensive help for a specific command, including its syntax, summary, remarks, and parameter descriptions. This is useful for understanding exactly how to use a command and what each parameter does.

Examples:

  1. Show help for the 'add' command in the 'connections' group:
    gcc help connections add

  2. Show help for the 'delete' command in the 'databases' group:
    gcc help databases delete

Notes:

  • The output includes the command signature, summary, remarks, and parameter details.
  • Use this command to get in-depth usage information for any GCC command.

group

The name of the command group containing the command. Provide the group name as shown in the list of command groups (e.g., 'connections', 'databases').

command

The name of the command to display help for. Provide the command name as shown in the group's command list (e.g., 'add', 'delete').
Notification