History

Sagi Dayan d5d1eecb89 Some checks failed Codespell / Check for spelling errors (push) Failing after 1m26s Details Initial commit Signed-off-by: Sagi Dayan <sagidayan@gmail.com>		2024-12-12 20:18:00 +02:00
..
LICENSE	Initial commit	2024-12-12 20:18:00 +02:00
README.md	Initial commit	2024-12-12 20:18:00 +02:00
trap_others.go	Initial commit	2024-12-12 20:18:00 +02:00
trap_windows.go	Initial commit	2024-12-12 20:18:00 +02: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)