moby/vendor/github.com/inconshreveable/mousetrap
Sebastiaan van Stijn 26c4429f7e
vendor: github.com/spf13/cobra v1.6.1
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-11-23 17:58:08 +01:00
..
LICENSE vendor: github.com/spf13/cobra v1.6.1 2022-11-23 17:58:08 +01:00
README.md rerun vndr 2017-03-08 02:29:34 +00:00
trap_others.go project: use vndr for vendoring 2016-11-03 15:31:46 -07:00
trap_windows.go project: use vndr for vendoring 2016-11-03 15:31:46 -07:00
trap_windows_1.4.go project: use vndr for vendoring 2016-11-03 15:31:46 -07:00

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)