Reference Guide#

Introduction#

The CLI application, Melissa Updater, offers simplicity and uses the Releases service to check for updates, download files, and verify the integrity of those files.

After testing, scheduling a batch file or PowerShell script to utilize the CLI tool could automate the process entirely.

For more information on the Melissa Releases API, please see: Melissa Releases

Verbs of Action#

Verb

Description

file

Download a single file.

manifest

Download all files within a product.

verify

Verify a file or a folder path.

help

Display more information on a specific command.

version

Display version information.

Features#

Download a file#

Parameters#

Short

Long

Description

-a

–architecture

The specific architecture for the binary file (64BIT, 32BIT, ANY).

-c

–compiler

The specific compiler for the binary file (ACC3, ANY, C, COM, DLL, GCC32, GCC34, GCC41, GCC46, GCC48, GCC83, JAVA, MSSQL, NET, PERL, PHP, PHP7, PLSQL, PYTHON, RUBY, SSIS2005, SSIS2008, SSIS2012, SSIS2014, SSIS2016, SSIS2017, SSIS2019, WS12, WS6, XLC12, XLC6).

-d

–dry_run

Simulate the process without modifying any files.

-f

–force

Force the download and overwrite existing file(s).

-l

–license

The valid Melissa license string for the product you wish to download.

-n

–filename

The filename to download.

-o

–os

The specific operating system for the binary file (AIX, ANY, HPUX_IT, HPUX_PA, LINUX, SOLARIS, WINDOWS, ZLINUX).

-q

–quiet

Run the program in quiet mode without console output except for errors.

-r

–release_version

The release version (YYYY.MM, YYYY.Q#, LATEST) for the product you wish to download (e.g. “2023.01” or “2023.Q1” or “LATEST”).

-t

–target_directory

The target directory where to place the downloaded file(s). If not specified, the default is the current directory.

-w

–working_directory

The working directory where to temporarily stage downloaded file(s) before moving into the target directory.

-x

–callback

Action command for the next script or process to run (Windows only).

-y

–type

The specific file type to be downloaded (BINARY, DATA, INTERFACE).

–help

Display the help screen.

–version

Display version information.

Try it Now#

Download an interface file#
  • WINDOWS
  • LINUX
.\MelissaUpdater.exe file `
    -n "{{Filename}}" `
    -r "{{ReleaseVersion}}" `
    -l "{{LicenseKey}}" `
    -y "INTERFACE" -o "WINDOWS" -a "ANY" `
    -c "{{Compiler}}" `
    -t "{{Path}}"
./MelissaUpdater file \
    -n "{{Filename}}" \
    -r "{{ReleaseVersion}}" \
    -l "{{LicenseKey}}" \
    -y "INTERFACE" -o "LINUX" -a "ANY" \
    -c "{{Compiler}}" \
    -t "{{Path}}"
Download a binary file#
  • WINDOWS
  • LINUX
.\MelissaUpdater.exe file `
    -n "{{Filename}}" `
    -r "{{ReleaseVersion}}" `
    -l "{{LicenseKey}}" `
    -y "BINARY" -o "WINDOWS" -a "64BIT" -c "DLL" `
    -t "{{Path}}"
./MelissaUpdater file \
    -n "{{Filename}}" \
    -r "{{ReleaseVersion}}" \
    -l "{{LicenseKey}}" \
    -y "BINARY" -o "LINUX" -a "64BIT" -c "DLL" \
    -t "{{Path}}"
Download a data file#
  • WINDOWS
  • LINUX
.\MelissaUpdater.exe file `
    -n "{{Filename}}" `
    -r "{{ReleaseVersion}}" `
    -l "{{LicenseKey}}" `
    -y "DATA" -o "ANY" -c "ANY" -a "ANY" `
    -t "{{Path}}"
./MelissaUpdater file \
    -n "{{Filename}}" \
    -r "{{ReleaseVersion}}" \
    -l "{{LicenseKey}}" \
    -y "DATA" -o "ANY" -c "ANY" -a "ANY" \
    -t "{{Path}}"

For data files, flags for type (-y), operating system (-o), architecture (-a), and compiler (-c) are not mandatory.

Download to a working directory#
  • WINDOWS
  • LINUX
.\MelissaUpdater.exe file `
    -n "{{Filename}}" `
    -r "{{ReleaseVersion}}" `
    -l "{{LicenseKey}}" `
    -y "DATA" -o "ANY" -c "ANY" -a "ANY" `
    -t "{{Path}}"
    -w "{{WorkingPath}}"
./MelissaUpdater file \
    -n "{{Filename}}" \
    -r "{{ReleaseVersion}}" \
    -l "{{LicenseKey}}" \
    -y "DATA" -o "ANY" -c "ANY" -a "ANY" \
    -t "{{Path}}"
    -w "{{WorkingPath}}"
Dry run mode#
  • WINDOWS
  • LINUX
.\MelissaUpdater.exe file -d `
    -n "{{Filename}}" `
    -r "{{ReleaseVersion}}" `
    -l "{{LicenseKey}}" `
    -y "DATA" -o "ANY" -c "ANY" -a "ANY" `
    -t "{{Path}}"
./MelissaUpdater file -d \
    -n "{{Filename}}" \
    -r "{{ReleaseVersion}}" \
    -l "{{LicenseKey}}" \
    -y "DATA" -o "ANY" -c "ANY" -a "ANY" \
    -t "{{Path}}"
Quiet mode#
  • WINDOWS
  • LINUX
.\MelissaUpdater.exe file -q `
    -n "{{Filename}}" `
    -r "{{ReleaseVersion}}" `
    -l "{{LicenseKey}}" `
    -y "DATA" -o "ANY" -c "ANY" -a "ANY" `
    -t "{{Path}}"
./MelissaUpdater file -q \
    -n "{{Filename}}" \
    -r "{{ReleaseVersion}}" \
    -l "{{LicenseKey}}" \
    -y "DATA" -o "ANY" -c "ANY" -a "ANY" \
    -t "{{Path}}"

If you choose to download individual files, be wary that this could cause data conflicts. All data files and binaries should be from the same release.

Download a manifest#

You can retrieve a list of available manifest names using the Melissa Releases API: https://releases.melissadata.net/ManifestList/YYYY.MM

Alternatively, you can view it in a browser: https://releases.melissadata.net/Browse

Parameters#

Short

Long

Description

-d

–dry_run

Simulate the process without modifying any files.

-f

–force

Force the download and overwrite existing file(s).

-i

–index

Retrieve and list all files in a manifest.

-l

–license

The valid Melissa license string for the product you wish to download.

-m

–map

The map file with your custom file structure for downloaded file(s).

-p

–product

The product or manifest name to be downloaded.

-q

–quiet

Run the program in quiet mode without console output except for errors.

-r

–release_version

The release version (YYYY.MM, YYYY.Q#, LATEST) for the product you wish to download (e.g. “2023.01” or “2023.Q1” or “LATEST”).

-t

–target_directory

The target directory where to place the downloaded file(s). If not specified, the default is the current directory.

-w

–working_directory

The working directory where to temporarily stage downloaded file(s) before moving into the target directory.

-x

–callback

Action command for the next script or process to run (Windows only).

–help

Display the help screen.

–version

Display version information.

Try it Now#

Download a manifest without Map directory#
  • WINDOWS
  • LINUX
.\MelissaUpdater.exe manifest `
    -p "{{ProductName}}" `
    -r "{{ReleaseVersion}}" `
    -l "{{LicenseKey}}" `
    -t "{{Path}}"
.\MelissaUpdater manifest \
    -p "{{ProductName}}" \
    -r "{{ReleaseVersion}}" \
    -l "{{LicenseKey}}" \
    -t "{{Path}}"

Without a Map directory, all files in the product will be downloaded into the same folder.

Download a manifest with Map directory#
  • WINDOWS
  • LINUX
.\MelissaUpdater.exe manifest `
    -p "{{ProductName}}" `
    -r "{{ReleaseVersion}}" `
    -l "{{LicenseKey}}" `
    -t "{{Path}}" `
    -m "{{MapPath}}"
.\MelissaUpdater manifest \
    -p "{{ProductName}}" \
    -r "{{ReleaseVersion}}" \
    -l "{{LicenseKey}}" \
    -t "{{Path}}" \
    -m "{{MapPath}}"

With a Map directory, all files in the product will be downloaded into folder/subfolders based on the structure specified in .map files.

You can pass in either absolute or relative map file path. Map files structure examples can be found at MelissaData/MelissaUpdater.

Download to a working directory#
  • WINDOWS
  • LINUX
.\MelissaUpdater.exe manifest `
    -p "{{ProductName}}" `
    -r "{{ReleaseVersion}}" `
    -l "{{LicenseKey}}" `
    -t "{{Path}}" `
    -w "{{WorkingPath}}"
.\MelissaUpdater manifest \
    -p "{{ProductName}}" \
    -r "{{ReleaseVersion}}" \
    -l "{{LicenseKey}}" \
    -t "{{Path}}" \
    -w "{{WorkingPath}}"
Dry run mode#
  • WINDOWS
  • LINUX
.\MelissaUpdater.exe manifest -d `
    -p "{{ProductName}}" `
    -r "{{ReleaseVersion}}" `
    -l "{{LicenseKey}}" `
    -t "{{Path}}"
.\MelissaUpdater manifest -d \
    -p "{{ProductName}}" \
    -r "{{ReleaseVersion}}" \
    -l "{{LicenseKey}}" \
    -t "{{Path}}"
Quiet mode#
  • WINDOWS
  • LINUX
.\MelissaUpdater.exe manifest -q `
    -p "{{ProductName}}" `
    -r "{{ReleaseVersion}}" `
    -l "{{LicenseKey}}" `
    -t "{{Path}}"
.\MelissaUpdater manifest -q \
    -p "{{ProductName}}" \
    -r "{{ReleaseVersion}}" \
    -l "{{LicenseKey}}" \
    -t "{{Path}}"
Index mode#
  • WINDOWS
  • LINUX
.\MelissaUpdater.exe manifest -i `
    -p "{{ProductName}}" `
    -r "{{ReleaseVersion}}" `
    -l "{{LicenseKey}}"
.\MelissaUpdater manifest -i \
    -p "{{ProductName}}" \
    -r "{{ReleaseVersion}}" \
    -l "{{LicenseKey}}"

Verify a file or a folder path#

Parameters#

Short

Long

Description

-p

–path

The file or folder path that you wish to verify.

-q

–quiet

Run the program in quiet mode without console output except for errors.

-x

–callback

Action command for the next script or process to run (Windows only).

–help

Display the help screen.

–version

Display version information.

Try it Now#

Verify#
  • WINDOWS
  • LINUX
.\MelissaUpdater.exe verify `
    -p "{{Path}}"
./MelissaUpdater verify \
    -p "{{Path}}"
Quiet mode#
  • WINDOWS
  • LINUX
.\MelissaUpdater.exe verify -q `
    -p {{Path}}
./MelissaUpdater verify -q \
    -p {{Path}}