swiftDialog

https://swiftdialog.app/
Admin
swiftDialog is a modern macOS dialog utility for administrators that displays beautiful,...
Tokens:48,992
Snippets:727
Trust Score:5.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### Basic Application Installer Configuration

Source: https://swiftdialog.app/advanced/inspect-mode

Example configuration for an application installer dialog. Includes title, message, preset, icon details, cache paths, button text, and a list of applications to install with their respective paths and icons.

```json
{
  "title": "Installing Office Suite",
  "message": "Please wait while we install your applications",
  "preset": "preset1",
  "icon": "sf=apps.iphone.badge.plus",
  "iconBasePath":"/Users/Shared/icons/",
  "cachePaths": ["/Users/Shared/Downloads"],
  "button1text": "Please Wait...",
  "button1disabled": true,
  "autoEnableButton": true,
  "autoEnableButtonText": "Continue",
  "items": [
    {
      "id": "microsoft_word",
      "displayName": "Microsoft Word",
      "guiIndex": 0,
      "paths": ["/Applications/Microsoft Word.app"],
      "icon": "Microsoft Word.png"
    },
    {
      "id": "microsoft_excel",
      "displayName": "Microsoft Excel",
      "guiIndex": 1,
      "paths": ["/Applications/Microsoft Excel.app"],
      "icon": "Microsoft Excel.png"
    },
    {
      "id": "microsoft_powerpoint",
      "displayName": "Microsoft PowerPoint",
      "guiIndex": 2,
      "paths": ["/Applications/Microsoft PowerPoint.app"],
      "icon": "Microsoft PowerPoint.png"
    }
  ]
}
```

--------------------------------

### Select and Install Applications Script

Source: https://swiftdialog.app/examples/demo-scripts

This script uses the Dialog application to present a list of software options to the user via checkboxes. It then simulates an installation process by updating a progress bar and displaying status messages. The script requires Dialog to be installed at /usr/local/bin/dialog.

```python
#!/usr/bin/python3


import time
import os
import subprocess
import json


# [appname, install_trigger]
app_array = [
  ["Firefox","jamf policy -event FIREFOX"],
  ["Microsoft Edge", "installomator.sh microsoftedge"],
  ["Google Chrome", "installomator.sh googlechrome"],
  ["Adobe Photoshop", "jamf policy -event PHOTOSHOP"],
  ["Some Other Stuff", "jamf policy -event OTHERSTUFF"],
  ["Some More Stuff", "jamf policy -event MORESTUFF"]
  ]


dialogApp = "/usr/local/bin/dialog"


progress = 0
progress_steps = 100
progress_per_step = 1

# build string array for dialog to display
app_list = []
for app_name in app_array:
  app_list.append(["⬜️",app_name[0],app_name[1]])



def writeDialogCommands(command):
  file = open("/var/tmp/dialog.log", "a")
  file.writelines("{}\n".format(command))
  file.close()


def updateDialogCommands(array, steps):
  string = "__Installing Software__\\n\\n"

  for item in array:
    string = string + "{} - {}  \n".format(item[0],item[1])

  writeDialogCommands("message: {}".format(string))
  if steps > 0:
    writeDialogCommands("progress: {}".format(steps))


# app string
app_string = ""
for app_name in app_array:
  app_string = "{} --checkbox '{}'".format(app_string, app_name[0])


# Run dialogApp and return the results as json
dialog_cmd = "{} --title 'Software Installation' \
--message 'Select Software to install:' \
--icon SF=desktopcomputer.and.arrow.down,colour1=#3596f2,colour2=#11589b \
--button1text Install \
-2 -s --height 420 --json {} ".format(dialogApp, app_string)


result = subprocess.Popen(dialog_cmd, shell=True, stdout=subprocess.PIPE)
text = result.communicate()[0]   # contents of stdout
#print(text)


result_json = json.loads(text)


print(result_json)


for key in result_json:
  print(key, ":", result_json[key])
  for i, app_name in enumerate(app_list):
    #print(i)
    if key == app_name[1] and result_json[key] == False:
      print("deleting {} at index {}".format(key, i))
      app_list.pop(i)


print(app_list)


# re-calc steps per item
progress_per_step = progress_steps/len(app_list)

os.system("{} --title 'Software Installation' \
        --message 'Software Install is about to start' \
        --button1text 'Please Wait' \
        --icon SF=desktopcomputer.and.arrow.down,colour1=#3596f2,colour2=#11589b \
        --blurscreen \
        --progress {} \
        -s --height 420 \
        &\
".format(dialogApp, progress_steps))

```

--------------------------------

### Multiselect List Example

Source: https://swiftdialog.app/advanced/select-lists

Example command to create a multiselect list, allowing multiple options to be chosen. Selected items are returned as a comma-separated string.

```bash
--selecttitle "Choose options",multiselect --selectvalues "Option One, Option Two, Option Three, Option Four"
```

--------------------------------

### Example: Initializing and Updating List Statuses

Source: https://swiftdialog.app/advanced/item-lists

Demonstrates initializing a list with multiple items and then updating their statuses individually using commands.

```bash
echo "list: Test item 1, Test item 2, Test item 3" >> /var/tmp/dialog.log
```

```bash
echo "listitem: Test item 1: Complete ✅" >> /var/tmp/dialog.log
```

```bash
echo "listitem: Test item 2: There was an error processing this item ❌" >> /var/tmp/dialog.log
```

```bash
echo "listitem: Test item 3: wait" >> /var/tmp/dialog.log
```

--------------------------------

### Install Dialog with Installomator

Source: https://swiftdialog.app/reference/updates

Use Installomator to install Dialog. This command downloads and runs the Installomator script to install Dialog.

```shell
./Installomator.sh dialog
```

--------------------------------

### Required Select List Example

Source: https://swiftdialog.app/advanced/select-lists

Example command to create a required select list. The user must select a value before swiftDialog exits.

```bash
--selecttitle "Required item",required --selectvalues "Option One, Option Two, Option Three"
```

--------------------------------

### Example: Execute a Say Command

Source: https://swiftdialog.app/examples/shell-commands

Demonstrates executing a simple shell command like 'say thank you for running dialog' using the `--button1shellaction` parameter.

```shell
--button1shellaction "say thank you for running dialog"
```

--------------------------------

### Multiselect Output Example

Source: https://swiftdialog.app/advanced/select-lists

Example of the output format for a multiselect list, showing selected items as a comma-separated string.

```bash
"Choose options" : "Option One, Option Three"
```

--------------------------------

### Web Content and List Items in Presentation

Source: https://swiftdialog.app/advanced/presentation

This example demonstrates using presentation mode with web content in the info area and list items in the main content area.

```shell
dialog --presentation --infobox "<url>" --listitem ...<items>...
```

--------------------------------

### Select List Default Example Output

Source: https://swiftdialog.app/advanced/select-lists

Example output when a default value is not specified and the user selects an item. This output is only shown if swiftDialog's exit code is 0.

```bash
SelectedOption: Option 1
SelectedIndex: 0
```

--------------------------------

### Radio Button Select List Example

Source: https://swiftdialog.app/advanced/select-lists

Example command to display a select list as radio buttons. When using 'radio' without a default, the first item becomes the default.

```bash
--selecttitle "Radio buttons",radio --selectvalues "Option One, Option Two, Option Three"
```

--------------------------------

### Basic LaunchAgent for Login Window

Source: https://swiftdialog.app/operation/login-window

This is an example of a basic LaunchAgent configuration to run a script at the login window. Ensure the ProgramArguments points to your script and LimitLoadToSessionType is set to LoginWindow.

```plist
<plist version="1.0">
<dict>
  <key>OnDemand</key>
  <false/>
  <key>LaunchOnlyOnce</key>
  <true/>
  <key>ProgramArguments</key>
  <array>
    <string>/path/to/script.sh</string>
  </array>
  <key>LimitLoadToSessionType</key>
  <string>LoginWindow</string>
  <key>Label</key>
  <string>com.swiftDialog.example-login-window</string>
</dict>
</plist>
```

--------------------------------

### Multiselect JSON Output Example

Source: https://swiftdialog.app/advanced/select-lists

Example of the JSON output format for a multiselect list.

```json
{
  "Choose options" : "Option One, Option Three"
}
```

--------------------------------

### JSON Select Items Configuration

Source: https://swiftdialog.app/advanced/select-lists

Example JSON configuration for multiple select items, including one with a default value.

```json
"selectitems" : [
  {"title" : "Select 1", "values" : ["one","two","three"]},
  {"title" : "Select 2", "values" : ["red","green","blue"], "default" : "red"}
]
```

--------------------------------

### Create User Input Form

Source: https://swiftdialog.app/

This example demonstrates how to create a dialog with text fields for user input, allowing collection of details like name and email.

```shell
# User input form
dialog --title "User Information" \
       --message "Please enter your details:" \
       --textfield "Name,prompt=Enter your name" \
       --textfield "Email,prompt=Enter your email" \
       --button1text "Submit"
```

--------------------------------

### Multiple Text Fields Example

Source: https://swiftdialog.app/advanced/textfields

Shows how to define multiple text fields in a single dialog. Ensure sufficient dialog height.

```bash
dialog --textfield "First Name" --textfield "Surname" --textfield "Age" --textfield "Favourite Colour"
```

--------------------------------

### Verify SwiftDialog Installation

Source: https://swiftdialog.app/getting-started/installation

Run this command in your terminal to check if SwiftDialog is installed and accessible.

```bash
dialog --version
```

--------------------------------

### Equivalent of --style alert

Source: https://swiftdialog.app/advanced/window-size

This example shows the equivalent command-line arguments for the --style alert preset, demonstrating custom title, icon size, message formatting, alignment, and dimensions.

```bash
dialog --title none --iconsize 80 --message "### An Important Message  \n\nThis contains important message content\n\nPlease read" --messagealignment centre --buttonstyle centre --centreicon --width 300 --height 300
```

--------------------------------

### Initialize and Update Dialog UI

Source: https://swiftdialog.app/examples/demo-scripts

This script initializes the dialog by setting initial states and then updates it during a simulated software installation process. It demonstrates controlling button states, text, and progress indicators.

```python
# give time for Dialog to launch
time.sleep(0.5)
writeDialogCommands("button1: disable")


time.sleep(2)
writeDialogCommands("title: Software Installation")
writeDialogCommands("button1text: Please Wait")
writeDialogCommands("progress: 0")


#Process the list
for app in app_list:
  progress = progress + progress_per_step
  writeDialogCommands("progressText: Installing {}...".format(app[1]))
  app[0] = "⏳"


  updateDialogCommands(app_list, 0)


  ##### This is where you'd perform the install


  # Pretend install happening
  print("Right now we would be running this command\n : {}".format(app[2]))
  time.sleep(1)
  writeDialogCommands("progress: increment")
  time.sleep(1)
  writeDialogCommands("progress: increment")
  time.sleep(1)
  writeDialogCommands("progress: increment")
  time.sleep(1)
  writeDialogCommands("progress: increment")


  app[0] = "✅"


  updateDialogCommands(app_list, progress)
  writeDialogCommands("progressText: Installing {}...".format(app[1]))
  time.sleep(1)

writeDialogCommands("icon: SF=checkmark.shield.fill,colour1=#27db2d,colour2=#1b911f")
writeDialogCommands("progressText: Complete")
writeDialogCommands("button1text: Done")
writeDialogCommands("button1: enable")
```

--------------------------------

### Text Field Output Example

Source: https://swiftdialog.app/advanced/textfields

Demonstrates the standard output format for a single text field, showing the label and user input.

```text
Textfield 1 : This is what the user entered
```

--------------------------------

### Preset 5 Configuration Example

Source: https://swiftdialog.app/advanced/inspect/preset5

This JSON configuration defines the structure and content for a self-service portal workflow, including intro steps with text, bullets, and simulated deployment steps with app information. Edit this file to customize your portal.

```json
{
  "highlightColor" : "#007AFF",
  "introSteps" : [
    {
      "content" : [
        {
          "content" : "This is a two-step starter. Edit config.json to add more steps, change layouts, or customise the content.",
          "type" : "text"
        },
        {
          "items" : [
            "Step types: intro, deployment, carousel, guide, showcase, bento, processing, portal, outro",
            "55+ content block types available",
            "Add branding, forms, compliance checks"
          ],
          "type" : "bullets"
        }
      ],
      "continueButtonText" : "Next",
      "heroImage" : "SF=macbook.gen2",
      "heroImageSize" : 180,
      "id" : "welcome",
      "showBackButton" : false,
      "stepType" : "intro",
      "subtitle" : "Your starter Preset 5 workflow (example)",
      "title" : "Welcome"
    },
    {
      "continueButtonText" : "Finish",
      "heroImage" : "SF=arrow.down.app.fill",
      "id" : "apps",
      "items" : [
        {
          "displayName" : "Safari",
          "guiIndex" : 0,
          "icon" : "/Applications/Safari.app",
          "id" : "safari",
          "paths" : [
            "/Applications/Safari.app"
          ]
        },
        {
          "displayName" : "Calculator",
          "guiIndex" : 1,
          "icon" : "/System/Applications/Calculator.app",
          "id" : "calculator",
          "paths" : [
            "/System/Applications/Calculator.app"
          ]
        },
        {
          "displayName" : "TextEdit",
          "guiIndex" : 2,
          "icon" : "/System/Applications/TextEdit.app",
          "id" : "textedit",
          "paths" : [
            "/System/Applications/TextEdit.app"
          ]
        }
      ],
      "showBackButton" : true,
      "stepType" : "deployment",
      "subtitle" : "Simulated deployment step",
      "title" : "App Installation"
    }
  ],
  "preset" : "5"
}
```

--------------------------------

### App Deployment Configuration (Preset 1)

Source: https://swiftdialog.app/advanced/inspect/preset1

This JSON configuration defines the appearance and content for Preset 1, a traditional sidebar layout. It includes highlight color, an icon, a list of applications to install, a message, the preset number, and the title.

```json
{
  "highlightColor" : "#007AFF",
  "icon" : "SF=arrow.down.app.fill",
  "items" : [
    {
      "displayName" : "Safari",
      "icon" : "/Applications/Safari.app",
      "id" : "safari",
      "paths" : [
        "/Applications/Safari.app"
      ],
      "showBundleInfo" : "all"
    },
    {
      "displayName" : "Calculator",
      "icon" : "/System/Applications/Calculator.app",
      "id" : "calculator",
      "paths" : [
        "/System/Applications/Calculator.app"
      ],
      "showBundleInfo" : "all"
    },
    {
      "displayName" : "TextEdit",
      "icon" : "/System/Applications/TextEdit.app",
      "id" : "textedit",
      "paths" : [
        "/System/Applications/TextEdit.app"
      ],
      "showBundleInfo" : "all"
    }
  ],
  "message" : "Installing applications...(example)",
  "preset" : "1",
  "title" : "App Deployment"
}
```

--------------------------------

### Create Dialog CLI Symlink

Source: https://swiftdialog.app/operation/dialogcli

Creates the `/usr/local/bin/dialog` symlink pointing to the Dialog CLI launcher. This command must be run as root and is typically handled by the swiftDialog installer.

```bash
sudo Dialog.app/Contents/MacOS/dialog --link
```

--------------------------------

### JSON Select Items with Radio Style

Source: https://swiftdialog.app/advanced/select-lists

Example JSON configuration for a select item styled as radio buttons.

```json
"selectitems" : [
  {"title" : "Pick One", "values" : ["One","Two","Three"], "style" : "radio"}
]
```

--------------------------------

### Advanced Checkbox Example with JSON

Source: https://swiftdialog.app/advanced/checkboxes

Demonstrates various checkbox configurations including checked, disabled, and default states using a JSON object.

```json
{
  "checkbox" : [
    {"label" : "Option 1", "checked" : true, "disabled" : true },
    {"label" : "Option 2", "checked" : true, "disabled" : false },
    {"label" : "Option 3", "checked" : false },
    {"label" : "Option 4", "checked" : true, "disabled" : true },
    {"label" : "Option 5" },
    {"label" : "Option 6", "disabled" : true }
  ]
}
```

--------------------------------

### Display Progress Indicator

Source: https://swiftdialog.app/

Use this command to show a progress indicator dialog, useful for informing users about ongoing processes like software installation.

```shell
# Progress indicator
dialog --title "Installing Software" \
       --message "Please wait while we set things up..." \
       --progress 10 \
       --progresstext "Starting installation..."
```

--------------------------------

### Example: Handling a Bad Command

Source: https://swiftdialog.app/examples/shell-commands

Illustrates the output when an invalid command is provided to `--button1shellaction`. Dialog still exits with code 0, but the shell error is displayed.

```shell
.../Dialog.app/Contents/MacOS/Dialog --button1shellaction "bad command here"
zsh:1: command not found: bad

```

--------------------------------

### Acceptable Use Policy Dialog for Login Window

Source: https://swiftdialog.app/operation/login-window

An example of an Acceptable Use Policy dialog displayed at the login window. It requires user agreement via a checkbox and displays content from a markdown file using the --eula mode. The dialog is configured to blur the screen and run in the login window context.

```bash
dialog --message "/path/to/AcceptableUsePolicy.md" --height 50% --width 35% --style centred --icon sf=rectangle.and.pencil.and.ellipsis,colour=accent --title "{COMPANY-NAME} Acceptable Use" --button1disabled --checkbox "I Agree",enableButton1 --quitkey A --eula --blurscreen --loginwindow
```

--------------------------------

### Callback Script for Validation

Source: https://swiftdialog.app/advanced/cards

Example script to validate email format before allowing advancement. Exit code 0 permits advancement; non-zero blocks it.

```bash
#!/bin/bash
# script.sh - Validate email format before advancing


input=$(cat)
email=$(echo "$input" | jq -r '.["Email Address"]')


if [[ ! "$email" =~ ^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Z|a-z]{2,}$ ]]; then
    echo "Invalid email address format"
    exit 1
fi


exit 0

```

--------------------------------

### MDM Payload for Notification Settings

Source: https://swiftdialog.app/advanced/notifications

This example demonstrates an MDM payload for configuring notification settings for multiple Dialog bundle identifiers. It specifies alert types, badge, lock screen, and notification center visibility.

```xml
<key>PayloadContent</key>
<array>
    <dict>
        <key>PayloadDisplayName</key>
        <string>Notifications Payload</string>
        <key>PayloadIdentifier</key>
        <string>449B1259-E631-4051-ADCE-9532B813ADDC</string>
        <key>PayloadOrganization</key>
        <string>Org Name</string>
        <key>PayloadType</key>
        <string>com.apple.notificationsettings</string>
        <key>PayloadUUID</key>
        <string>12EA8FDA-B204-4AD0-802C-C980615F0BA5</string>
        <key>PayloadVersion</key>
        <integer>1</integer>
        <key>NotificationSettings</key>
        <array>
            <dict>
                <key>AlertType</key>
                <integer>1</integer>
                <key>BadgesEnabled</key>
                <true/>
                <key>BundleIdentifier</key>
                <string>au.bartreardon.dialog</string>
                <key>CriticalAlertEnabled</key>
                <false/>
                <key>NotificationsEnabled</key>
                <true/>
                <key>ShowInLockScreen</key>
                <true/>
                <key>ShowInNotificationCenter</key>
                <true/>
                <key>SoundsEnabled</key>
                <true/>
            </dict>
            <dict>
                <key>AlertType</key>
                <integer>1</integer>
                <key>BadgesEnabled</key>
                <true/>
                <key>BundleIdentifier</key>
                <string>au.csiro.dialog</string>
                <key>CriticalAlertEnabled</key>
                <false/>
                <key>NotificationsEnabled</key>
                <true/>
                <key>ShowInLockScreen</key>
                <true/>
                <key>ShowInNotificationCenter</key>
                <true/>
                <key>SoundsEnabled</key>
                <true/>
            </dict>
            <dict>
                <key>AlertType</key>
                <integer>1</integer>
                <key>BadgesEnabled</key>
                <true/>
                <key>BundleIdentifier</key>
                <string>au.csiro.dialog.banner</string>
                <key>CriticalAlertEnabled</key>
                <false/>
                <key>NotificationsEnabled</key>
                <true/>
                <key>ShowInLockScreen</key>
                <true/>
                <key>ShowInNotificationCenter</key>
                <true/>
                <key>SoundsEnabled</key>
                <true/>
            </dict>
            <dict>
                <key>AlertType</key>
                <integer>2</integer>
                <key>BadgesEnabled</key>
                <true/>
                <key>BundleIdentifier</key>
                <string>au.csiro.dialog.alert</string>
                <key>CriticalAlertEnabled</key>
                <false/>
                <key>NotificationsEnabled</key>
                <true/>
                <key>ShowInLockScreen</key>
                <true/>
                <key>ShowInNotificationCenter</key>
                <true/>
                <key>SoundsEnabled</key>
                <true/>
            </dict>
        </array>
    </dict>
</array>
```

--------------------------------

### Parse Dialog stdout with Awk

Source: https://swiftdialog.app/operation/capturing-output

Extract specific output fields from Dialog using awk, particularly useful for parsing selections or text field inputs. The example shows how to get the selected option.

```bash
/usr/local/bin/dialog <...> | grep "SelectedOption" | awk -F " : " '{print $NF}'

```

--------------------------------

### Run Onboarding Wizard with JSON File

Source: https://swiftdialog.app/advanced/cards

Executes the swiftDialog application using a pre-defined JSON configuration file to display the employee onboarding wizard.

```bash
dialog --jsonfile onboarding.json
```

--------------------------------

### Shell Script for Employee Onboarding

Source: https://swiftdialog.app/advanced/cards

A complete shell script that generates a swiftDialog JSON configuration dynamically, displays the onboarding wizard, processes the output using `jq`, and includes placeholders for custom logic.

```bash
#!/bin/bash


# onboarding.sh - Employee onboarding with swiftDialog cards


DIALOG="/usr/local/bin/dialog"
CONFIG="/tmp/onboarding_config.json"


# Create the JSON configuration
cat > "$CONFIG" << 'EOF'
{
  "title": "Employee Onboarding",
  "icon": "SF=person.crop.circle.badge.checkmark",
  "width": 700,
  "height": 450,
  "cards": [
    {
      "title": "Welcome",
      "message": "Welcome to Company XYZ! This wizard will set up your account."
    },
    {
      "title": "Enter Details",
      "message": "Please provide your information:",
      "textfield": [
        { "title": "Full Name", "required": true },
        { "title": "Email", "required": true }
      ]
    },
    {
      "title": "Complete",
      "message": "Onboarding complete for {Full Name}!",
      "infobox": "We'll send a confirmation to {Email}"
    }
  ]
}
EOF


# Run dialog and capture output
if output=$("$DIALOG" --jsonfile "$CONFIG" 2>&1); then
    echo "Onboarding completed successfully!"
    echo "Collected data:"
    echo "$output" | jq .


    # Extract specific fields
    full_name=$(echo "$output" | jq -r '.["Full Name"]')
    email=$(echo "$output" | jq -r '.Email')


    echo "Processing onboarding for $full_name ($email)..."


    # Add your custom logic here
    # - Create user account
    # - Send welcome email
    # - Configure systems


else
    echo "Onboarding was cancelled or failed"
    exit 1
fi


# Cleanup
rm -f "$CONFIG"

```

--------------------------------

### Display Local Video File

Source: https://swiftdialog.app/basic-use/video

Use the `--video` command followed by the file path to display a local video. The dialog window will resize to accommodate the video. Custom sizes can be set with `--width` and `--height`.

```bash
--video /Users/Shared/Videos/day4session3.mp4
```

--------------------------------

### Launch swiftDialog with Inspect Mode and Config File

Source: https://swiftdialog.app/advanced/inspect-mode

Execute swiftDialog with the --inspect-mode flag, specifying the configuration file path.

```bash
/usr/local/bin/dialog --inspect-mode --inspect-config /path/to/config.json
```

--------------------------------

### Uninstall SwiftDialog

Source: https://swiftdialog.app/getting-started/installation

Remove SwiftDialog from your system by deleting the binary from its installation path.

```bash
sudo rm /usr/local/bin/dialog
```

--------------------------------

### File Select with Initial Path

Source: https://swiftdialog.app/advanced/textfields

Use `path=<path>` with `fileselect` to set the directory the file picker initially opens to.

```bash
--textfield "Log File,fileselect,path=/var/log"
```

--------------------------------

### Complete Employee Onboarding Wizard JSON

Source: https://swiftdialog.app/advanced/cards

Defines a multi-card dialog for employee onboarding, including personal information, department selection, system preferences, and a review step with variable substitution.

```json
{
  "title": "Employee Onboarding",
  "icon": "/System/Library/CoreServices/CoreTypes.bundle/Contents/Resources/UserIcon.icns",
  "width": 750,
  "height": 500,
  "button1text": "Continue",
  "cards": [
    {
      "title": "Welcome to the Company!",
      "message": "## Welcome Aboard!\n\nThis wizard will guide you through the onboarding process.\n\nClick Continue to get started.",
      "icon": "SF=hands.clap.fill",
      "iconsize": 120
    },
    {
      "title": "Personal Information",
      "message": "Please provide your personal details (all fields required):",
      "textfield": [
        { "title": "First Name", "required": true },
        { "title": "Last Name", "required": true },
        { "title": "Employee ID", "required": true },
        { "title": "Work Email", "required": true, "prompt": "name@company.com" }
      ]
    },
    {
      "title": "Department Assignment",
      "message": "Select your department and role:",
      "selectitems": [
        {
          "title": "Department",
          "values": ["Engineering", "Marketing", "Sales", "HR", "Finance"],
          "default": "Engineering"
        },
        {
          "title": "Role",
          "values": ["Manager", "Senior", "Mid-level", "Junior"],
          "default": "Mid-level"
        }
      ]
    },
    {
      "title": "System Preferences",
      "message": "Configure your system preferences:",
      "checkbox": [
        { "label": "Enable email notifications", "checked": true },
        { "label": "Join company Slack", "checked": true },
        { "label": "Subscribe to company newsletter", "checked": true },
        { "label": "Opt-in to mentorship program", "checked": false }
      ]
    },
    {
      "title": "Review & Confirm",
      "message": "Please review your information before completing the onboarding process:",
      "icon": "SF=checkmark.circle",
      "infobox": "**Name:** {First Name} {Last Name}\n**Employee ID:** {Employee ID}\n**Email:** {Work Email}\n\n**Department:** {Department}\n**Role:** {Role}\n\n**Email Notifications:** {Enable email notifications}\n**Slack:** {Join company Slack}\n**Newsletter:** {Subscribe to company newsletter}\n**Mentorship:** {Opt-in to mentorship program}",
      "button1text": "Complete Onboarding"
    }
  ]
}
```

--------------------------------

### Checkbox Output (JSON)

Source: https://swiftdialog.app/advanced/checkboxes

Get checkbox results in JSON format by specifying the `--json` parameter. This provides a structured output of selected options.

```json
{
  "Option 2" : true,
  "Option 4" : true,
  "Option 5" : false,
  "Option 6" : true,
  "Option 1" : true,
  "Option 3" : false
}
```

--------------------------------

### Accept Multiple Image/Icon Files

Source: https://swiftdialog.app/reference/releasenotes/sd3-0-0

The `--image` and `--icon` arguments can now accept a comma-separated list of file paths for multiple images or icons.

```bash
dialog --image "/path/image1.png","/path/image2.png","/path/image3.png"
```

--------------------------------

### Check Dialog Bundle Identifiers

Source: https://swiftdialog.app/advanced/notifications

Use these commands to verify the bundle identifiers for Dialog helper applications on your system. This is useful for confirming installed versions and their associated identifiers.

```shell
defaults read "/Library/Application Support/Dialog/Dialog.app/Contents/Helpers/Dialog Banner.app/Contents/Info.plist" CFBundleIdentifier
```

```shell
defaults read "/Library/Application Support/Dialog/Dialog.app/Contents/Helpers/Dialog Alert.app/Contents/Info.plist" CFBundleIdentifier
```

--------------------------------

### Play Sound on Launch

Source: https://swiftdialog.app/reference/releasenotes/sd3-0-0

Use the `--sound` argument to play an audio file or URL when the dialog is launched. Add `--showsoundcontrols` for long audio files.

```bash
dialog --sound /System/Library/Sounds/Glass.aiff
```

--------------------------------

### Customize Button 1 Text

Source: https://swiftdialog.app/basic-use/buttons

Modify the label of the default 'OK' button using the --button1text option. This allows for custom text to guide user interaction.

```bash
--button1text "Enter to Continue"
```

--------------------------------

### Simple Three-Step Wizard Configuration

Source: https://swiftdialog.app/advanced/cards

A complete JSON configuration for a three-step wizard, including titles, messages, input fields with validation, and custom button text.

```json
{
  "title": "Setup Wizard",
  "icon": "SF=gearshape.2",
  "button1text": "Continue",
  "cards": [
    {
      "title": "Welcome",
      "message": "Welcome to the setup wizard. Click Continue to begin."
    },
    {
      "title": "Enter Information",
      "message": "Please provide your details:",
      "textfield": [
        { "title": "Full Name", "required": true },
        { "title": "Email Address", "required": true }
      ]
    },
    {
      "title": "Complete",
      "message": "Setup is complete! Click Finish to close this wizard.",
      "button1text": "Finish"
    }
  ]
}
```

--------------------------------

### Select List with Alternate Name Output

Source: https://swiftdialog.app/advanced/select-lists

Example of using the 'name' modifier to specify an alternate output name for a select list. Includes standard and alternate name output formats.

```bash
% dialog --selecttitle "Alternate Name",name=alt --selectvalues "Option One, Option Two, Option Three"

"SelectedOption" : "Option One"
"SelectedIndex" : 0
"alt" : "Option One"
"alt" index : "0"
```

--------------------------------

### Load Info Box from File

Source: https://swiftdialog.app/advanced/command-file

Load the info box content from a specified Markdown file.

```bash
echo "infobox: /path/to/infobox.md" >> /var/tmp/dialog.log

```

--------------------------------

### Configure Cache Monitoring for Downloads

Source: https://swiftdialog.app/advanced/inspect-mode

Specify directories to monitor for download progress and set the scan interval in seconds. The system detects .pkg, .dmg, and .download files matching item IDs.

```json
{
  "cachePaths": [
    "/Library/Managed Installs/Cache",
    "/Library/Application Support/Installomator/Downloads",
    "/Library/Application Support/JAMF/Downloads",
    "/Library/Application Support/AirWatch/Data/Munki/Managed Installs/Cache"
  ],
  "scanInterval": 5
}
```

--------------------------------

### Test SwiftDialog Dialog

Source: https://swiftdialog.app/getting-started/installation

Use this command to display a simple test dialog, confirming SwiftDialog's functionality.

```bash
dialog --title "Test" --message "swiftDialog is installed!"
```

--------------------------------

### Set Info Button Action to Open URL

Source: https://swiftdialog.app/basic-use/buttons

Configure the 'More Information' button to perform an action, such as opening a URL, using the --infobuttonaction option. The --quitoninfo flag can restore default exit behavior.

```bash
--infobuttonaction "https://github.com/"
```

--------------------------------

### Customize Title Font Properties

Source: https://swiftdialog.app/basic-use/title

Use the `--titlefont` option with `property=value` pairs, separated by commas, to customize font properties like color, size, weight, name, alignment, and offset. For example, to modify only the size, use `size=<float>`.

```bash
--titlefont "size=60"
```

```bash
--titlefont "colour=#00A4C7,weight=light,size=60"
```

```bash
--titlefont "name=Chalkboard-Bold,colour=#D054A0,size=40"
```

```bash
--titlefont alignment=left
```

```bash
--titlefont alignment=right
```

--------------------------------

### Clear and Update Dialog with New Web Content

Source: https://swiftdialog.app/basic-use/video

To switch to a new website, first clear the existing content by echoing `webcontent: none` to `/var/tmp/dialog.log`, then echo the new URL. These commands can be chained.

```bash
echo "webcontent: none" >> /var/tmp/dialog.log
echo "webcontent: https://some.new.website.com" >> /var/tmp/dialog.log
```

```bash
echo "webcontent: none" >> /var/tmp/dialog.log && echo "webcontent: https://some.new.website.com" >> /var/tmp/dialog.log
```

--------------------------------

### App Catalog Configuration

Source: https://swiftdialog.app/advanced/inspect/preset2

This JSON configuration defines the 'App Catalog' preset, including highlight color, icon, and a list of application items with their display names, icons, IDs, paths, and bundle info visibility.

```json
{
  "highlightColor" : "#34C759",
  "icon" : "SF=rectangle.split.3x1.fill",
  "items" : [
    {
      "displayName" : "Safari",
      "icon" : "/Applications/Safari.app",
      "id" : "safari",
      "paths" : [
        "/Applications/Safari.app"
      ],
      "showBundleInfo" : "all"
    },
    {
      "displayName" : "Calculator",
      "icon" : "/System/Applications/Calculator.app",
      "id" : "calculator",
      "paths" : [
        "/System/Applications/Calculator.app"
      ],
      "showBundleInfo" : "all"
    },
    {
      "displayName" : "TextEdit",
      "icon" : "/System/Applications/TextEdit.app",
      "id" : "textedit",
      "paths" : [
        "/System/Applications/TextEdit.app"
      ],
      "showBundleInfo" : "all"
    }
  ],
  "message" : "Installing applications...(example)",
  "preset" : "2",
  "title" : "App Catalog"
}
```

--------------------------------

### Modify Message Font, Color, and Size

Source: https://swiftdialog.app/basic-use/message

The --messagefont option allows customization of the message's font, text size, and color. Colors can be specified by name or hex code, and size accepts float values. Font name accepts any installed font.

```bash
--messagefont "name=Chalkboard-Bold,colour=#D054A0,size=40"
```

--------------------------------

### Display Image from File or URL

Source: https://swiftdialog.app/basic-use/images

Use the --image flag to display an image from a local file or a URL. Images are resized to fit the display area. The --imagecaption flag can be used for a description.

```bash
-g, --image  <file> | <url>
  Display an image instead of a message.
  Images will be resized to fit the available display area


    --imagecaption <text>
    Text that will appear underneath the displayed image.
```

--------------------------------

### Run swiftDialog with JSON Configuration

Source: https://swiftdialog.app/advanced/cards

Command to execute a swiftDialog with a JSON configuration file. Ensure the path to your configuration file is correct.

```bash
dialog --jsonfile /path/to/config.json
```

--------------------------------

### Basic Dialog Configuration

Source: https://swiftdialog.app/advanced/command-line-options

Sets the title and message for a simple dialog. Use `--help <option>` for detailed information about a specific argument.

```bash
dialog --title "Hello" --message "World"
```

--------------------------------

### Specify Icon from File or URL

Source: https://swiftdialog.app/basic-use/icon

Use the --icon option to specify an image file (png, jpg) or a URL to an image resource. Images are resized to fit the display area.

```bash
--icon /path/to/your/icon.png
```

```bash
--icon "https://user-images.githubusercontent.com/3598965/111854068-84f6ab00-8971-11eb-935b-487f1a15b91f.png"
```

--------------------------------

### Set a Notification Action (URL or Shell Command)

Source: https://swiftdialog.app/advanced/notifications

Configure a notification to perform an action when clicked. This can be opening a URL or executing a shell command using `--button1action`. `--button1action` is the default action.

```bash
dialog --notification --style banner --title "<text>" --message "<text>" --button1action "open -a Safari.app"
```

```bash
dialog --notification --style banner --title "<text>" --message "<text>" --button1action "https://swiftdialog.app/"
```

--------------------------------

### Set Background Image or Color

Source: https://swiftdialog.app/advanced/background-images

Use `--background` to display a file as a background image or set a solid color. The dialog window height adjusts if the image is larger than default. Solid colors can have an optional gradient overlay.

```bash
--background <file | url | colour= >
```

```bash
--background colour=red
```

```bash
--background colour=#ff0000
```

```bash
--background colour=red,nogradient
```

--------------------------------

### Create JSON Configuration for Inspect Mode

Source: https://swiftdialog.app/advanced/inspect-mode

Define the applications and their paths to be monitored by swiftDialog's Inspect Mode.

```json
{
  "title": "Application Installation",
  "items": [
    {
      "id": "app1",
      "displayName": "Microsoft Word",
      "guiIndex": 0,
      "paths": ["/Applications/Microsoft Word.app"]
    }
  ]
}
```

--------------------------------

### JSON Configuration with Boolean Values

Source: https://swiftdialog.app/advanced/json-configuration

Demonstrates how to use boolean values (true/false without quotes) for options that accept them. These include 'infobutton', 'hideicon', and 'quitoninfo', among others.

```json
{
  "button2" : false,
  "infobutton" : false,
  "hideicon" : false,
  "moveable" : false,
  "ontop" : false,
  "small" : false,
  "big" : false,
  "fullscreen" : false,
  "json" : false,
  "ignorednd" : false,
  "hidetimerbar" : false,
  "quitoninfo" : false
}
```

--------------------------------

### Basic Text-Only Presentation

Source: https://swiftdialog.app/advanced/presentation

Use this command to display text-based information in presentation mode. It supports markdown for infobox content and allows specifying an icon.

```shell
dialog --presentation --infobox "<markdown>" --icon "<image>" --message "<markdown>"
```

--------------------------------

### Advanced JSON for Item List with Icons and Status

Source: https://swiftdialog.app/advanced/item-lists

Initialize a list with advanced options including icons, status, and status text for each item. Supports local paths, app paths, and URLs for icons.

```json
{
  "listitem" : [
    {"title" : "Item One", "icon" : "/path/to/image", "status" : "pending", "statustext" : "Pending"},
    {"title" : "Item Two", "icon" : "/path/to/SomeApp.app", "status" : "wait", "statustext" : "Waiting"},
    {"title" : "Item Three", "icon" : "https://some.url/image", "status" : "success", "statustext" : "Winning"}
  ]
}
```

--------------------------------

### Set Dark/Light Mode Icons in Python

Source: https://swiftdialog.app/basic-use/icon

This Python script checks the system's appearance mode and sets the 'icon' key in the content dictionary accordingly. It relies on Foundation framework for detecting the theme.

```python
from Foundation import NSBundle

def is_dark_mode():
    appearanceBundle = NSBundle.bundleWithPath_(
        "/System/Library/PreferencePanes/Appearance.prefPane"
    )
    appearanceShared = appearanceBundle.classNamed_("AppearanceShared")
    app = appearanceShared.sharedAppearanceAccess()
    if app.theme() == 1:
        return False
    else:
        return True


if is_dark_mode():
    content["icon"] = "dark_icon.png"
else:
    content["icon"] = "light_icon.png"

```

--------------------------------

### Apply Global Defaults to Cards

Source: https://swiftdialog.app/advanced/cards

Demonstrates how to set global default properties like 'icon' and 'button1text' at the root level, which can be overridden by individual cards.

```json
{
  "icon": "/System/Library/CoreServices/CoreTypes.bundle/Contents/Resources/AlertNoteIcon.icns",
  "button1text": "Continue",
  "cards": [
    { "title": "Step 1", "message": "Uses default icon" },
    { "title": "Step 2", "icon": "SF=checkmark.circle", "message": "Custom icon" }
  ]
}
```

--------------------------------

### Set Button Size via Command Line or File

Source: https://swiftdialog.app/reference/whats-new

Control the size of buttons (mini, small, large) using the --buttonsize option or by setting it in a command file. Defaults to regular if not specified or invalid.

```bash
dialog --buttonsize large --commandfile /var/tmp/dialog.txt
```

```bash
echo "buttonsize: mini" >> /var/tmp/dialog.txt
```

--------------------------------

### Basic JSON for Item List

Source: https://swiftdialog.app/advanced/item-lists

Use this basic JSON structure to initialize a simple list of items without any status.

```json
{
  "listitem" : ["Item 1", "Item 2", "Item 3"]
}
```

--------------------------------

### Debug Log for Image Size

Source: https://swiftdialog.app/advanced/presentation

When running presentation mode with `--debug`, this log output provides recommended image dimensions for the sidebar based on the current window size.

```text
DEBUG: Ideal presentation sidebar image size for these window dimensions would be width:492.0, height:636.0
```

--------------------------------

### Set Button 1 Action to Open URL

Source: https://swiftdialog.app/basic-use/buttons

Assign an action to the default button, such as opening a URL in the user's default browser, using the --button1action option.

```bash
--button1action "https://github.com/"
```

--------------------------------

### Display Simple Notification

Source: https://swiftdialog.app/

Use this basic command to display a simple notification dialog with a title, message, and icon.

```shell
# Simple notification
dialog --title "Welcome" \
       --message "Hello from swiftDialog!" \
       --icon "SF=star.fill"
```

--------------------------------

### Configure Pre-set Window Style (Alert)

Source: https://swiftdialog.app/advanced/window-size

The --style alert option configures a pre-set dialog window with specific dimensions and centered content, suitable for important messages.

```bash
dialog --style alert
```

--------------------------------

### Configure Button Symbols with Options

Source: https://swiftdialog.app/basic-use/buttons

Assign SF Symbols to buttons using --button1symbol, --button2symbol, or --infobuttonsymbol. Optional parameters for position, rendering mode, size, and color can be specified as comma-separated values.

```bash
--button1symbol heart.fill,color=red
```

--------------------------------

### Set Overlay Icon

Source: https://swiftdialog.app/advanced/command-file

Add an overlay icon on top of the main icon. Use 'overlayicon: none' to remove it.

```bash
echo "overlayicon: checkmark.seal.fill" >> /var/tmp/dialog.log

```

```bash
echo "overlayicon: none" >> /var/tmp/dialog.log

```

--------------------------------

### Display Image in Base64 Format

Source: https://swiftdialog.app/basic-use/images

Images can be specified in base64 format using the 'base64=' prefix with the --icon flag.

```bash
--icon base64=<base64_text>
```

--------------------------------

### Unordered List Formatting

Source: https://swiftdialog.app/basic-use/markdown

Create bulleted lists using asterisks and newlines.

```bash
dialog --message " * point 1
 * point 2
 * point 3"
```

--------------------------------

### Basic Checkbox Usage

Source: https://swiftdialog.app/advanced/checkboxes

Use `--checkbox <text>` to display a simple checkbox with a label. This is the most basic way to offer a selectable option.

```bash
dialog --checkbox "My Checkbox"
```

--------------------------------

### Load Message from File

Source: https://swiftdialog.app/advanced/command-file

Load the message content from a specified Markdown file.

```bash
echo "message: /path/to/message.md" >> /var/tmp/dialog.log

```

--------------------------------

### Launch Dialog in Background

Source: https://swiftdialog.app/advanced/command-file

Launch Dialog in the background to enable sending commands. A short sleep is recommended to allow Dialog to initialize.

```bash
/usr/local/bin/dialog &
sleep 0.1

```

--------------------------------

### Set Dialog Window Size Using Percentage

Source: https://swiftdialog.app/advanced/window-size

Use percentage values with --width or --height to set the dialog size relative to the current screen resolution.

```bash
dialog --width 50%
```

--------------------------------

### JSON Configuration with Multiple Images

Source: https://swiftdialog.app/advanced/json-configuration

Specify multiple images and their captions using an array of objects within the 'image' key. Each object should contain 'imagename' and 'caption'.

```json
{
  "image" : [
    {"imagename" : "/Users/Shared/Pictures/Image 1.jpg", "caption" : "Test image 1"},
    {"imagename" : "/Users/Shared/Pictures/Image 2.jpg", "caption" : "Test image 2"},
    {"imagename" : "/Users/Shared/Pictures/Image 3.jpg", "caption" : "Test image 3"}
  ]
}
```

--------------------------------

### Using Built-in and Environment Variables in Dialog

Source: https://swiftdialog.app/operation/builtin-variables

Demonstrates how to use built-in variables like {computermodel}, {osname}, and {osversion} within a swiftDialog command. Any environment variables can also be accessed this way.

```bash
dialog --icon computer --title "{computermodel}" --message "Running {osname} {osversion}" --style centred
```

--------------------------------

### Enable Mini Mode for Dialog Window

Source: https://swiftdialog.app/advanced/window-size

Use the --mini argument to enable mini mode, which forces a small window with a modified layout and limited content display options.

```bash
dialog --mini
```
Tokens:
Raw