Command Console

Grooper Command Console (GCC) is a command-line tool for performing system configuration and administration tasks in Grooper.

Remarks

Overview

GCC provides a unified command-line interface (CLI) for managing Grooper system components, including repositories, connections, services, and more. It is designed for both interactive and scripted use, allowing administrators to automate or manually perform a wide range of configuration and maintenance tasks.

Usage Modes

GCC can be run in two primary modes:

1. Direct Command Mode: Execute a single command from the command line. Example:
   gcc connections rename 1 "New Repository Name"

2. Interactive Mode: Launch GCC with no arguments to enter an interactive prompt. Example:
   gcc

   gcc>

   At the prompt, enter commands using the same syntax as direct mode:
   gcc> connections rename 1 "New Repository Name"

Command Syntax

The general syntax for commands is: gcc <group> <command> [parameters...]

• <group>: The command group, such as connections.
• <command>: The specific command to execute, such as rename.
• parameters...: Any required or optional parameters for the command. If a parameter contains spaces, enclose it in double quotes.

To view available command groups, type:
help
To view commands within a group:
help <group>
To view help for a specific command:
help <group> <command>

Exiting GCC

To exit the interactive prompt, type q, quit, or exit.

Permissions

Some operations, such as installing or managing services, require administrator rights. Use the Start Menu shortcut provided by the Grooper installer to launch GCC with the necessary permissions.

Examples

Rename a connection:
gcc connections rename 1 "New Repository Name"

List Grooper services installed on the local machine:
gcc services list

Install a Grooper service (requires administrator rights):
gcc services install "Grooper Processing Service"

Notes

• When specifying parameters, enter only the value (not the parameter name).
• Enclose parameters containing spaces in double quotes.
• For some commands, you may be prompted for additional input (such as passwords).

Command Groups

connections	Manage Grooper repository connections and perform administrative operations on connected repositories.
databases	Manage Grooper databases from the command line.
help	Display help for GCC command groups and commands.
license	Manage licensing for a local Grooper license server.
scripts	Commands used for integration with the Grooper SDK extension for Visual Studio.
services	Manage Grooper services on the local machine.
utils	Miscellaneous utilities for Grooper administration and automation.