History

Taylor Blau 4593d0a641 vendor: vendor dependencies in vendor/ using Glide - script/vendor received an update in order to work with Glide - import paths have been rewritten to work with GO15VENDOREXPERIMENT		2016-05-23 12:10:35 -06:00
..
LICENSE	vendor: vendor dependencies in vendor/ using Glide	2016-05-23 12:10:35 -06:00
README.md	vendor: vendor dependencies in vendor/ using Glide	2016-05-23 12:10:35 -06:00
trap_others.go	vendor: vendor dependencies in vendor/ using Glide	2016-05-23 12:10:35 -06:00
trap_windows_1.4.go	vendor: vendor dependencies in vendor/ using Glide	2016-05-23 12:10:35 -06:00
trap_windows.go	vendor: vendor dependencies in vendor/ using Glide	2016-05-23 12:10:35 -06:00

README.md

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)