Advanced Command line reference SpringCardCompanionTray
April 13, 2023 at 2:39 AMSpringCardCompanionTray
SpringCardCompanionTray.exe
is an executable that implements two very different roles:
- Basically, it is an icon that sits in the system’s tray bar to show the status of the background service,
- When the background service is not installed, SpringCard Companion Service features are implemented by the tray itself.
In a typical setup, the tray is started with the user session thanks to an entry in the Software\Microsoft\Windows\CurrentVersion\Run
branch of registry.
Syntax
SpringCardCompanionTray.exe [ACTION] [OPTIONS]
To start the tray, launch the executable with no ACTION. Only one single instance is allowed to run at a time.
Otherwise, specificy one ACTION parameter to control the tray application.
ACTION parameters
stop
: Close the tray application
SpringCardCompanionTray.exe --stop [OPTIONS]
This has the same effect as clicking the “Exit Companion Tray” entry in the tray’s popup menu.
install
: Register the tray application for auto-start (current user)
SpringCardCompanionTray.exe --install [OPTIONS]
install-global
: Register the tray application for auto-start (all users)
SpringCardCompanionTray.exe --install-global [OPTIONS]
Note: only system administrators can change global settings. Regular users should add the --elevate
option to the command-line.
uninstall
: Remove the tray application from auto-start (current user)
SpringCardCompanionTray.exe --uninstall [OPTIONS]
uninstall-global
: Remove the tray application from auto-start (all users)
SpringCardCompanionTray.exe --uninstall-global [OPTIONS]
Note: only system administrators can change global settings. Regular users should add the --elevate
option to the command-line.
OPTIONS parameters
elevate
: Perform UAC elevation (get admininistrator priviledges)
SpringCardCompanionTray.exe <ACTION> --elevate
no-splash
: Do not show the splash screen
SpringCardCompanionTray.exe <ACTION> --no-splash
Use this flag when starting the tray application to prevent the splash screen to show.
The splash screen may also be disabled by a configuration key in registry.
no-exit-confirm
: Do not prompt for confirmation when exiting
SpringCardCompanionTray.exe <ACTION> --no-exit-confirm
Use this flag when starting the tray application to disable the confirmation prompt when the user clicks the “Exit Companion Tray” entry in the tray’s popup menu.
The confirmation prompt may also be disabled by a configuration key in registry.
no-exit-menu
: Do not show exit in the menu
SpringCardCompanionTray.exe <ACTION> --no-exit-menu
Use this flag when starting the tray application to disable the “Exit Companion Tray” entry in the tray’s popup menu.
The exit menu may also be disabled by a configuration key in registry.
verbose
: Verbose output
SpringCardCompanionTray.exe <ACTION> --verbose [level]
Allowed values for level are:
- 1 : show execution errors,
- 2 : show execution errors and warnings,
- 3 : show execution errors and warnings, and show a basic trace of the execution flow,
- 4 : all of the above, plus show a detailed trace of the execution flow (this slows down the process),
- 5 : all of the above, plus show a detailed trace of the underlying libraries (this slows down the process a lot).
If the level parameter is absent, default value is 4.
console
: Open a console window
SpringCardCompanionTray.exe <ACTION> --console
Use this flag in conjunction with verbose
when starting the tray application.
pause
: Keep the console window open when the application exits
SpringCardCompanionTray.exe [ACTION] --pause
Use this flag when performing an ACTION to have enough time to read the messages. Hit the ENTER key to close the window when the application has terminated.