Command Line

The Insight Student Command Line gives network administrators increased flexibility in managing Insight computers. These commands can be run with several different third-party enterprise management tools, such as Apple Remote Desktop, and/or central management solutions; this includes executing commands in Terminal while connected to a remote computer via SSH.

Command	Description
--help	Display this help.
--password	Provide the admin password to execute any command except --help. Note: Providing the administrator password restricts command execution to authorized users only.
--settings	Display the current settings saved on this computer.
--uninstall	Uninstall Insight Student from this computer.
--securityToken	Define the security token. If supplied, the value can be passed as an environment variable by specifying '--env' at the end. Example: TOKEN="token" ADMINPSWD="password1" insightstudent --securityToken --adminPassword --env
--adminPassword	Define the Insight admin password. If supplied, the value can be passed as an environment variable by specifying '--env' at the end. Example: TOKEN="token" ADMINPSWD="password1" insightstudent --securityToken --adminPassword --env
--connectorAddress "value"	The value can be any valid IP address.
--defaultClassId "Class ID"	Set the default Class ID to the value specified. Note: If Class ID has space, the Class ID must be enclosed in quotes. Example: --defaultClassId "Home 100"
--menuBarIcon true | false	Show or hide the Insight Student icon in the menu bar.
--changeClassId true | false	Enable or disable Students from changing the Class ID in Insight.
--monitorKeystrokes true | false	Enable or disable monitoring keystrokes
--requirePermission true | false	When set to true, the Teacher will require permission from the Student to allow screen recording. These settings can be found in: For macOS Ventura or newer: System Settings --> Privacy & Security For macOS Monterey or older: System Preferences --> Security & Privacy --> Privacy The settings can be set using MDM solution, or set manually for each computer.
--webHistory true | false	Enable or disable tracking the web history on Student machines. Note: Enabling web history will also install the browser extension.
--installBrowserExtension	Setting this option will install the browser extensions on the Student system.
--restrictWiFi "value1,value2..." | --allowAllWiFi	Enable the ability for Insight to restrict what wireless networks the system can connect to.

Except for the --help, --settings, and --uninstall commands, the other commands may contain multiple options at the same time.

When password and/or token is specified, the command will prompt for the password and confirm it. Characters typed for the password and confirmation password will not be echoed on the Terminal.

In the event that command line is run with third-party management tool, the full path /usr/local/bin/insightstudent needs to be specified and the command has to be run as 'root' user.

When using third-party management tool, password and security token should be passed as environment variable by specifying --env at the end, to avoid having to enter the password and confirmation password. 'sudo' should not be used because the command is already running as 'root'.

Sample command line scenarios:

Terminal.app	Third-party management tool (executed as 'root' user)	Description
sudo insightstudent --password "admin password" --settings	/usr/local/bin/insightstudent --password "admin password" --settings	Prints the current settings.
sudo insightstudent --password "admin password" --adminPassword	ADMINPSWD="new password" /usr/local/bin/insightstudent --password "admin password" --adminPassword --env	Sets the new admin password and enters the password and confirmation at the prompt.
sudo insightstudent --password "admin password" --securityToken	TOKEN="token" /usr/local/bin/insightstudent --password "admin password" --securityToken --env	Sets the security token and enters the token and confirmation at the prompt.
sudo insightstudent --password "admin password" --adminPassword --defaultClassId "Home 100" --menuBarIcon false --changeClassId true --connectorAddress "192.168.0.1"	ADMINPSWD="new password" /usr/local/bin/insightstudent --password "admin password" --adminPassword --defaultClassId "Home 100" --menuBarIcon false --changeClassId true --connectorAddress "192.168.0.1" --env	Combines multiple options to set new admin password, default class ID, menu bar icon and Insight Connector IP address.
sudo insightstudent --password "admin password" --uninstall	/usr/local/bin/insightstudent --password "admin password" --uninstall	Uninstalls Insight Student.