Note: This article only applies to MCO eComms Guide for Desktop v4.x. For information on earlier versions see the related article on Guide Client v3.
Command Line Installation
To assist IT organizations that want to remotely deploy and configure Guide for Desktop across many computers, convenient operating system-specific scripts are made available.
While these scripts can be run directly on individual computers, they are intended to be used with remote computer management tools like Microsoft InTune. As such, the scripts are designed to run in a non-interactive manner removing the need for local user interaction during installation.
⚠️ To get the latest command line interface scripts to install and uninstall, contact [email protected]. These scripts are currently not available for download within the application. |
Windows 10 and Higher
For Windows there are two scripts:
Installation Script (.ps1) written for Powershell
Uninstall Script (.bat) written for DOS Batch
CLI Script for Windows Installation
From Powershell, execute guide-install-win.ps1 with the parameters necessary to configure the client to communicate with a specific customer account.
Syntax
.\guide-install-win.ps1 -customerId cid -securityKey key [-installFrom fname.exe]
Command Line Arguments
-customerId | The customer account id that can be found on the Settings > Client Installation page. Replace cid with the value. Do not use quotes. |
-securityKey | The client security key that can be found on the Settings > Client Installation page. Replace key with the value. Do not use quotes. |
-installFrom | [optional] The filename with path of the installation file that has been previously downloaded and is locally accessible to the script. Replace the fname.exe with your specific filename and location.
Use this option to install a specific version that is not the latest available. |
Examples
PS C:\fairwords>.\guide-install-win.ps1 -customerId 6271a6ee73c563d046ef4c45 -securityKey 7sRcGWButT34cTgnUCtCrWbYf4y8JuCOmLQQW8A2nA0=
PS C:\fairwords>.\guide-install-win.ps1 -customerId 6271a6ee73c563d046ef4c45 -securityKey 7sRcGWButT34cTgnUCtCrWbYf4y8JuCOmLQQW8A2nA0= -installFrom c:\temp\guide-4.0.17.exe
Installation Notes
When running the Powershell script, it is necessary for the execution policy to be set to RemoteSigned.
When running Powershell remotely with the goal of avoiding user interaction, GuideClient.exe should be added to the Allowed List in Windows Defender Firewall for both TCP and UDP traffic.
CLI for Windows Uninstall
Uninstalling Guide can be accomplished by running a simple batch script with no command line arguments. Like the install script, this can be remotely executed using InTune or a similar device management application.
Syntax
guide-uninstall-win.bat
MacOS 10.15 and Higher
For MacOS there are two Unix shell scripts:
Installation Script named guide-install-mac.sh
Uninstall Script named guide-uninstall-mac.sh
CLI Script for MacOS Installation
From a Terminal windows execute guide-install-mac.sh with the parameters necessary to configure the client to communicate with a specific customer account.
Syntax
./guide-install-mac.sh --customerId cid --securityKey key [--installFrom fname.dmg]
Command Line Arguments
--customerId | The customer account id that can be found on the Settings > Client Installation page. Replace cid with the value. Do not use quotes. |
--securityKey | The client security key that can be found on the Settings > Client Installation page. Replace key with the value. Do not use quotes. |
--installFrom | [optional] The filename with path of the installation file that has been previously downloaded and is locally accessible to the script. Replace the fname.dmg with your specific filename and location.
Use this option to install a specific version that is not the latest available. |
Examples
adminuser@admin fairwords % ./guide-install-mac.sh --customerId 6271a6ee73c563d046ef4c45 --securityKey 7sRcGWButT34cTgnUCtCrWbYf4y8JuCOmLQQW8A2nA0=
adminuser@admin fairwords % ./guide-install-mac.sh --customerId 6271a6ee73c563d046ef4c45 --securityKey 7sRcGWButT34cTgnUCtCrWbYf4y8JuCOmLQQW8A2nA0= --installFrom /temp/fairwords/guide-4.0.17.dmg
Installation Notes
To execute shell scripts ensure execute permissions on the .sh files are set (See Make a file executable in Terminal on Mac).
Fairwords Guide uses MacOS Accessibility features to analyze text. When installing Guide remotely on Mac, it is necessary to use the remote device management tool to allow Guide access to the Accessibility app. The installed app will be located at
/Applications/Guide Client.appand requires Accessibility set to Allow. If using Microsoft InTune, see additional instructions here.
CLI for MacOS Uninstall
Uninstalling Guide can be accomplished by running a simple shell script with no command line arguments. Like the install script, this can be remotely executed using InTune or a similar device management application.
Syntax
./guide-uninstall-mac.sh