README
¶
mousetrap
mousetrap is a tiny library that answers a single question.
On a Windows machine, was the process invoked by someone double clicking on the executable file while browsing in explorer?
Motivation
Windows developers unfamiliar with command line tools will often "double-click" the executable for a tool. Because most CLI tools print the help and then exit when invoked without arguments, this is often very frustrating for those users.
mousetrap provides a way to detect these invocations so that you can provide more helpful behavior and instructions on how to run the CLI tool. To see what this looks like, both from an organizational and a technical perspective, see https://inconshreveable.com/09-09-2014/sweat-the-small-stuff/
The interface
The library exposes a single interface:
func StartedByExplorer() (bool)
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func StartedByExplorer ¶
func StartedByExplorer() bool
StartedByExplorer returns true if the program was invoked by the user double-clicking on the executable from explorer.exe
It is conservative and returns false if any of the internal calls fail. It does not guarantee that the program was run from a terminal. It only can tell you whether it was launched from explorer.exe
On non-Windows platforms, it always returns false.
Types ¶
This section is empty.
Source Files