History

Sebastiaan van Stijn 1f6afab6e0 vendor: github.com/spf13/cobra v1.8.0 updating to current version. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>		2023-12-01 12:05:31 +01:00
..
LICENSE	go.mod: github.com/spf13/cobra v1.6.1	2022-11-02 19:48:45 +01:00
README.md	Update vendor directory to match expectation of vndr tool	2017-04-10 12:07:32 -07:00
trap_others.go	vendor: github.com/spf13/cobra v1.8.0	2023-12-01 12:05:31 +01:00
trap_windows.go	vendor: github.com/spf13/cobra v1.8.0	2023-12-01 12:05:31 +01: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)