Skip to content

Commit

Permalink
docs: add documentation on how to use mouse-position command
Browse files Browse the repository at this point in the history
  • Loading branch information
socsieng committed Dec 31, 2020
1 parent 9c10b84 commit 42e9955
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Expand Up @@ -131,6 +131,18 @@ A continuation can be used to ignore the next keystroke or instruction. This is

Insert a continuation using the character sequence `<\>`. The following instruction the sequence will be skipped over (including another continuation).

## Retrieving mouse position

The `mouse-position` sub command can be used to help determine which mouse coordinates to use in your scripts.

For a one off read, move your mouse to the desired position, switch to your terminal app using `command` + `tab` and execute the following command:

```sh
sendkeys mouse-position
```

Use the `--wait` option to capture multiple mouse positions in a session.

## Prerequisites

This application will only run on macOS 10.11 or later.
Expand Down

0 comments on commit 42e9955

Please sign in to comment.