podman/vendor/github.com/inconshreveable/mousetrap
baude 25a3923b61 Migrate to cobra CLI
We intend to migrate to the cobra cli from urfave/cli because the
project is more well maintained.  There are also some technical reasons
as well which extend into our remote client work.

Signed-off-by: baude <bbaude@redhat.com>
2019-02-08 10:26:43 -06:00
..
LICENSE Migrate to cobra CLI 2019-02-08 10:26:43 -06:00
README.md Migrate to cobra CLI 2019-02-08 10:26:43 -06:00
trap_others.go Migrate to cobra CLI 2019-02-08 10:26:43 -06:00
trap_windows.go Migrate to cobra CLI 2019-02-08 10:26:43 -06:00
trap_windows_1.4.go Migrate to cobra CLI 2019-02-08 10:26:43 -06: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)