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

scripts

Commands used for integration with the Grooper SDK extension for Visual Studio.

Remarks

The scripts command group provides commands used by the Grooper SDK extension for Visual Studio to synchronize script projects between the local file system and a Grooper repository. These commands are not intended for direct use by administrators or from the command line, but instead support automated workflows for script development and deployment within Visual Studio.

With the scripts group, the Grooper SDK extension can update script nodes in a repository from local project files, compile scripts after changes, download the latest script files from Grooper to a local project, and verify that local and repository scripts are in sync. This enables a seamless development experience, allowing script authors to work in Visual Studio while keeping Grooper repositories up to date.

These commands are essential for integrating Grooper script development into modern source control and CI/CD workflows, ensuring that script changes are reliably transferred and compiled as part of the development process. Direct use of these commands is not supported; they are invoked automatically by the SDK extension as needed.

For help on a specific command, use:
gcc help scripts <command>

Commands

Below are the commands in this group

getLatest <path> <repositoryId> <nodeId>

Update the local script project with files from the Grooper node.

This command is used internally by the Grooper SDK Visual Studio Extension and is not intended for direct use from the command line. It downloads the latest script files from a Grooper script node and updates the local Visual Studio project directory.

Examples:

  1. Download the latest script files to a local project directory:
    gcc scripts getLatest "C:\Projects\MyScript" 12345678-90ab-cdef-1234-567890abcdef 00112233-4455-6677-8899-aabbccddeeff

Notes:

  • This command is typically invoked by the Grooper SDK extension, not by administrators.
  • The repository and node IDs must be valid GUIDs.
  • Local files will be overwritten with the latest version from Grooper.

path

The Visual Studio destination project directory. Provide the full path to the local project directory to update.

repositoryId

The Grooper repository id as a GUID. Specify the repository containing the script node.

nodeId

The id of the node to save the script on, as a GUID. Specify the script node to download from.

mismatch <path> <repositoryId> <nodeId>

Compare local script files to the files stored on the Grooper node.

This command is used internally by the Grooper SDK Visual Studio Extension and is not intended for direct use from the command line. It checks whether the local script files are out of sync with the files stored in the Grooper script node.

Examples:

  1. Check for mismatches between local and Grooper script files:
    gcc scripts mismatch "C:\Projects\MyScript" 12345678-90ab-cdef-1234-567890abcdef 00112233-4455-6677-8899-aabbccddeeff

Notes:

  • This command is typically invoked by the Grooper SDK extension, not by administrators.
  • The repository and node IDs must be valid GUIDs.
  • If a mismatch is detected, an exception will be thrown.

path

The Visual Studio destination project directory. Provide the full path to the local project directory to check.

repositoryId

The Grooper repository id as a GUID. Specify the repository containing the script node.

nodeId

The id of the node to save the script on, as a GUID. Specify the script node to compare against.

update <path> <repositoryId> <nodeId>

Save a script project to Grooper from a file system directory.

This command is used internally by the Grooper SDK Visual Studio Extension and is not intended for direct use from the command line. It saves the contents of a Visual Studio script project directory to a script node in a Grooper repository.

Examples:

  1. Update a script node from a local project directory:
    gcc scripts update "C:\Projects\MyScript" 12345678-90ab-cdef-1234-567890abcdef 00112233-4455-6677-8899-aabbccddeeff

Notes:

  • This command is typically invoked by the Grooper SDK extension, not by administrators.
  • The repository and node IDs must be valid GUIDs.

path

The Visual Studio project directory to be saved. Provide the full path to the local project directory containing the script files.

repositoryId

The Grooper repository id as a GUID. Specify the target repository where the script node resides.

nodeId

The id of the node to save the script on, as a GUID. Specify the target script node in the repository.

updateAndCompile <path> <repositoryId> <nodeId>

Save and compile a script project to Grooper from a file system directory.

This command is used internally by the Grooper SDK Visual Studio Extension and is not intended for direct use from the command line. It saves the contents of a Visual Studio script project directory to a script node in a Grooper repository and compiles the script.

Examples:

  1. Update and compile a script node from a local project directory:
    gcc scripts updateAndCompile "C:\Projects\MyScript" 12345678-90ab-cdef-1234-567890abcdef 00112233-4455-6677-8899-aabbccddeeff

Notes:

  • This command is typically invoked by the Grooper SDK extension, not by administrators.
  • The repository and node IDs must be valid GUIDs.
  • Compilation output will be displayed in the console.

path

The Visual Studio project directory to be saved. Provide the full path to the local project directory containing the script files.

repositoryId

The Grooper repository id as a GUID. Specify the target repository where the script node resides.

nodeId

The id of the node to save the script on, as a GUID. Specify the target script node in the repository.
Notification