ScriptRunner is a UI application designed to act as a shell for any command line program or script. The main idea behind ScriptRunner is to allow users to define actions in a JSON file, specifying the parameters for the programs/scripts. ScriptRunner automatically generates a UI form for entering these parameters, making it easy to run the desired script. This document provides a complete guide to using ScriptRunner, including the structure of the manifest file, an example, and a detailed explanation of its components.

The JSON schema for the ScriptRunner manifest file is available at: ScriptRunnerSchema.json

Cross-platform recommended approach

dotnet tool install --global ScriptRunnerGUI --no-cache --ignore-failed-sources

Prepare a manifest for your action and save it as json file

{
    "$schema": "https://raw.githubusercontent.com/cezarypiatek/ScriptRunnerPOC/main/schema/v1/ScriptRunnerSchema.json",
    "actions": [
        {
            "name": "SqlServerDocker",
            "description": "Run a Docker container with Microsoft SQL Server",
            "command": "docker run -e ACCEPT_EULA=Y -e MSSQL_SA_PASSWORD={MSSQL_SA_PASSWORD} -e MSSQL_PID={MSSQL_PID} -p {HOST_PORT}:1433 --name {CONTAINER_NAME} mcr.microsoft.com/mssql/server:latest",
            "installCommand": "docker pull mcr.microsoft.com/mssql/server:latest",
            "categories": ["Docker", "SQL Server"],
            "params": [
                {
                    "name": "MSSQL_PID",
                    "prompt": "dropdown",
                    "description": "Product Edition",
                    "default": "Developer",
                    "promptSettings": {
                        "options": "Developer,Express,Standard,Enterprise"
                    }
                },
                {
                    "name": "HOST_PORT",
                    "prompt": "numeric",
                    "description": "Server port",
                    "default": "1433"
                },
                {
                    "name": "MSSQL_SA_PASSWORD",
                    "prompt": "password",
                    "description": "Password for the SA"
                },
                {
                    "name": "CONTAINER_NAME",
                    "prompt": "text",
                    "description": "Name for the container",
                    "default": "sqlserver"
                }
            ]
        }
    ]
}

Add a file or directory with your action manifest to Action Sources

Using script list locate your action

This field points to the JSON schema that validates the manifest file. It ensures that the file adheres to the required structure and formats and provides intellisense in editors like VSCode.

This is an array of action objects. Each action defines a specific script or command-line program that the UI will execute.

Each action object has the following properties:

• name: A unique name for the action.
• description: A brief description of what the action does.
• command: The command or script to be executed. A command can contains placeholders in curly brackets that should match names from params section.
• installCommand: (Optional) A command to install necessary dependencies for the script.
• categories: An array of categories to which this action belongs.
• autoParameterBuilderStyle: Specifies the style for automatic parameter generation (e.g., powershell).
• params: An array of parameter objects that define the inputs required by the command.

Each parameter object has the following properties:

• name: The name of the parameter.
• prompt: The type of prompt (e.g., numeric, datePicker, filePicker, text).
• promptSettings: (Optional) Additional settings for the prompt (e.g., date format, culture).
• description: (Optional) A description of the parameter.
• default: (Optional) A default value for the parameter.

A single line text input.

• minLength (integer): Minimum length of the text.
• maxLength (integer): Maximum length of the text.

A multi-line text input.

• minLines (integer): Minimum number of lines.
• maxLines (integer): Maximum number of lines.

A password input.

• minLength (integer): Minimum length of the password.
• maxLength (integer): Maximum length of the password.

A checkbox input.

• checkedValue (string): Value when checkbox checked.
• uncheckedValue (string): Value when checkbox unchecked.

A dropdown selection input.

• options (string): Comma separated list of values.

A multi-select input.

• options (string): Comma separated list of values.
• delimiter (string): Delimiter for merging selected values.

A file picker input.

A directory picker input.

A file content input. An input content will be save to temporary dir and pass as a file path to executed action.

Type: object

A date picker input.

• format (string)
• yearVisible (boolean)
• monthVisible (boolean)
• dayVisible (boolean)
• todayAsDefault (boolean)
• culture (string)

A numeric input.

• min (number): Minimum value.
• max (number): Maximum value.
• step (number): Step value.

A time picker input.

• format (string): Time format (e.g., HH:mm).

function Get-ActionDefinition
{
  param($CommandPath)
  
  $data = Get-Command $CommandPath
  
   [Ordered]@{
    name = [regex]::Replace($data.Name.TrimEnd(".ps1"), "(\p{Ll})(\p{Lu})", '$1 $2')
    command = "pwsh -NoProfile -Command "+ $(Resolve-Path $CommandPath -Relative)
    autoParameterBuilderStyle = "powershell"
    params = foreach($key in  $data.Parameters.Keys)
    {
      [Ordered]@{
        name = $key
        description  = [regex]::Replace($key, "(\p{Ll})(\p{Lu})", '$1 $2')
        prompt = if($data.Parameters[$key].SwitchParameter)
                {
                  "checkbox" 
                }
                elseif($data.Parameters[$key].ParameterType.Name -eq "DateTime")
                {
                  "datePicker"
                }
                elseif($key -match "path")
                {
                  "filePicker"
                }
                else{
                  "text"
                }
      }
    }
  } | ConvertTo-Json -Depth 10
}