igcmd Commands

Complete reference for all ImageGlass command-line interface commands

Complete reference documentation for all 14 igcmd commands.

Quick Setup & Updates

quick-setup

Launch the ImageGlass quick setup wizard for initial configuration.

igcmd.exe quick-setup

Parameters: None

Exit Codes:

• 0 - Setup completed successfully
• 2 - Error during setup

Example:

igcmd.exe quick-setup

---

check-for-update

Check for available ImageGlass updates and display the update dialog.

igcmd.exe check-for-update

Parameters: None

Exit Codes:

• 0 - Check completed successfully
• 2 - Error checking for updates

Example:

igcmd.exe check-for-update

---

Wallpaper & Lock Screen

set-wallpaper

Set an image as the Windows desktop wallpaper.

igcmd.exe set-wallpaper <imagePath> <style>

imagePath · string · required

Full path to the image file

style · enum · required

Wallpaper display style. Options:

• Centered (0) - Center image on screen
• Stretched (1) - Stretch to fill screen
• Tiled (2) - Tile image across screen
• Current (-1) - Use current Windows wallpaper style

Exit Codes:

• 0 - Wallpaper set successfully
• 1 - Administrator privileges required
• 2 - Error setting wallpaper (invalid style or file error)

Examples:

# Set wallpaper centered
igcmd.exe set-wallpaper "C:\Photos\landscape.jpg" Centered

# Set wallpaper stretched
igcmd.exe set-wallpaper "C:\Photos\nature.png" Stretched

# Set wallpaper tiled
igcmd.exe set-wallpaper "C:\Photos\pattern.jpg" Tiled

# Use current wallpaper style
igcmd.exe set-wallpaper "C:\Photos\photo.jpg" Current

See also: Set Wallpaper Guide

---

set-lock-screen

Set an image as the Windows lock screen background.

igcmd.exe set-lock-screen <imagePath>

imagePath · string · required

Full path to the image file

Exit Codes:

• 0 - Lock screen set successfully
• 1 - Administrator privileges required
• 2 - Error setting lock screen

Example:

igcmd.exe set-lock-screen "C:\Photos\lockscreen.jpg"

---

File Associations

set-default-viewer

Register ImageGlass as the default photo viewer for specified file extensions.

igcmd.exe set-default-viewer [extensions] [--per-machine] [--ui]

extensions · string · default: "all supported formats"

Semicolon-separated list of extensions. Example: .jpg;.png;.gif

If omitted, all supported image formats are registered.

--per-machine · flag

Apply system-wide (requires administrator privileges)

--ui · flag

Show confirmation dialog on success

Exit Codes:

• 0 - Registration successful
• 1 - Administrator privileges required (with —per-machine)
• 2 - Error during registration

Examples:

# Register all supported formats (current user)
igcmd.exe set-default-viewer

# Register specific formats
igcmd.exe set-default-viewer ".jpg;.png;.gif"

# Register system-wide with confirmation
igcmd.exe set-default-viewer ".jpg;.png" --per-machine --ui

See also: File Associations Guide

---

remove-default-viewer

Unregister ImageGlass as the default photo viewer for specified file extensions.

igcmd.exe remove-default-viewer [extensions] [--per-machine] [--ui]

extensions · string · default: "all registered formats"

Semicolon-separated list of extensions. Example: .jpg;.png;.gif

If omitted, all registered formats are unregistered.

--per-machine · flag

Apply system-wide (requires administrator privileges)

--ui · flag

Show confirmation dialog on success

Exit Codes:

• 0 - Unregistration successful
• 1 - Administrator privileges required (with —per-machine)
• 2 - Error during unregistration

Examples:

# Unregister all formats
igcmd.exe remove-default-viewer

# Unregister specific formats
igcmd.exe remove-default-viewer ".jpg;.png"

# Unregister system-wide
igcmd.exe remove-default-viewer --per-machine

See also: File Associations Guide

---

Image Operations

export-frames

Export individual frames from animated images (GIF, WebP, APNG, etc.).

igcmd.exe export-frames <imagePath>

imagePath · string · required

Full path to the animated image file

Behavior:

• Opens a folder picker dialog to select destination
• Extracts all frames to the selected folder
• Frames are numbered sequentially

Exit Codes:

• 0 - Frames exported successfully
• 2 - Error (file not found or invalid format)

Examples:

# Export frames from animated GIF
igcmd.exe export-frames "C:\Images\animation.gif"

# Export frames from animated WebP
igcmd.exe export-frames "C:\Images\animated.webp"

Supported formats:

• Animated GIF
• Animated WebP
• Animated PNG (APNG)
• Multi-frame TIFF

See also: Export Frames Guide

---

lossless-compress

Perform lossless compression on an image to reduce file size without quality loss.

igcmd.exe lossless-compress <imagePath>

imagePath · string · required

Full path to the image file to compress

Behavior:

• Compresses the image file in-place
• No quality loss (lossless compression)
• Original file is overwritten

Exit Codes:

• 0 - Compression successful
• 1 - Administrator privileges required
• 2 - Error during compression

Example:

igcmd.exe lossless-compress "C:\Photos\image.png"

Note: Make a backup before compressing if you want to preserve the original file.

---

start-slideshow

Start a slideshow from a specific image file.

igcmd.exe start-slideshow <imagePath>

imagePath · string · required

Full path to the starting image file

Behavior:

• Opens fullscreen slideshow viewer
• Starts with the specified image
• Includes all images in the same folder

Exit Codes:

• 0 - Slideshow completed
• 2 - Error (file not found or invalid path)

Example:

igcmd.exe start-slideshow "C:\Photos\vacation\IMG001.jpg"

---

Customization

install-languages

Install one or more language pack files.

igcmd.exe install-languages <filePath> [filePath2] [filePath3] ...

filePath · string · required

Path to language pack file(s) (.iglang files)

Multiple files can be specified separated by spaces

Exit Codes:

• 0 - Language pack(s) installed successfully
• 1 - Administrator privileges required
• 2 - Error during installation

Examples:

# Install single language pack
igcmd.exe install-languages "Spanish.iglang"

# Install multiple language packs
igcmd.exe install-languages "French.iglang" "German.iglang" "Italian.iglang"

Installation location:

• Language packs are installed to the ImageGlass languages directory
• After installation, select the language in ImageGlass settings

---

install-themes

Install one or more theme pack files.

igcmd.exe install-themes <filePath> [filePath2] [filePath3] ...

filePath · string · required

Path to theme pack file(s) (.igtheme files)

Multiple files can be specified separated by spaces

Exit Codes:

• 0 - Theme pack(s) installed successfully
• 1 - Administrator privileges required
• 2 - Error during installation

Examples:

# Install single theme
igcmd.exe install-themes "DarkMode.igtheme"

# Install multiple themes
igcmd.exe install-themes "Theme1.igtheme" "Theme2.igtheme"

# Install with UI confirmation
igcmd.exe install-themes "Custom.igtheme" --ui

Installation location:

• User themes: %APPDATA%\ImageGlass\Themes\
• After installation, select the theme in ImageGlass settings

---

uninstall-theme

Uninstall a theme pack by removing its directory.

igcmd.exe uninstall-theme <themeDirPath>

themeDirPath · string · required

Full path to the theme directory to remove

Exit Codes:

• 0 - Theme uninstalled successfully
• 2 - Error (theme not found or is default theme)

Example:

igcmd.exe uninstall-theme "C:\Users\User\AppData\Roaming\ImageGlass\Themes\CustomTheme"

Note: The default theme cannot be uninstalled.

---

Performance

set-startup-boost

Enable startup boost to launch ImageGlass with Windows for faster subsequent launches.

igcmd.exe set-startup-boost [--ui]

--ui · flag

Show confirmation dialog on success

Exit Codes:

• 0 - Startup boost enabled successfully
• 1 - Administrator privileges required
• 2 - Error enabling startup boost

Examples:

# Enable startup boost
igcmd.exe set-startup-boost

# Enable with confirmation
igcmd.exe set-startup-boost --ui

Behavior:

• Adds ImageGlass to Windows startup
• Runs in background to reduce launch time
• Does not open a window on startup

---

remove-startup-boost

Disable startup boost and remove ImageGlass from Windows startup.

igcmd.exe remove-startup-boost [--ui]

--ui · flag

Show confirmation dialog on success

Exit Codes:

• 0 - Startup boost disabled successfully
• 1 - Administrator privileges required
• 2 - Error disabling startup boost

Examples:

# Disable startup boost
igcmd.exe remove-startup-boost

# Disable with confirmation
igcmd.exe remove-startup-boost --ui

---

Global Options

These options can be combined with most commands:

—ui

Show UI dialogs for success and error messages.

igcmd.exe <command> [arguments] --ui

—per-machine

Apply settings system-wide instead of current user only. Requires administrator privileges.

igcmd.exe <command> [arguments] --per-machine

—hide-admin-error-ui

Suppress error dialogs when administrator privileges are required.

igcmd.exe <command> [arguments] --hide-admin-error-ui

Exit Code Handling

All commands return standard exit codes that can be checked in scripts:

# Batch script example
@echo off
igcmd.exe set-wallpaper "image.jpg" Centered

if %ERRORLEVEL% EQU 0 (
    echo Success
) else if %ERRORLEVEL% EQU 1 (
    echo Administrator privileges required
) else if %ERRORLEVEL% EQU 3 (
    echo File not found
) else (
    echo Error occurred
)

# PowerShell example
igcmd.exe set-wallpaper "image.jpg" Centered

switch ($LASTEXITCODE) {
    0 { Write-Host "Success" }
    1 { Write-Host "Administrator privileges required" }
    3 { Write-Host "File not found" }
    default { Write-Host "Error occurred" }
}

See Also

• CLI Overview
• Quick Setup Guide
• Wallpaper Commands
• File Associations
• Export Frames