Skip to content

Commit

Permalink
docs: update README to include details on apps sub command
Browse files Browse the repository at this point in the history
  • Loading branch information
socsieng committed Aug 22, 2021
1 parent cf6979a commit 40f49be
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.md
Expand Up @@ -38,6 +38,9 @@ cat example.txt | sendkeys --application-name "Notes"

_Activates the Notes application and sends keystrokes piped from `stdout` of the preceeding command._

Note that a list of applications that can be used in `--application-name` can be found using the
[`apps` sub command](#list-of-applications-names)

## Installation

### Homebrew (recommended)
Expand Down Expand Up @@ -267,6 +270,30 @@ sendkeys mouse-position --watch --output commands > mouse_commands.txt
sendkeys --input-file mouse_commands.txt
```

## List of applications names

A list of the current applications that can be activated by SendKeys (`--application-name`) can be displayed using the
`apps` command.

```sh
# list apps that can be activated with --application-name
sendkeys apps
```

Sample output:

```
Code id:com.microsoft.VSCode
Finder id:com.apple.finder
Google Chrome id:com.google.Chrome
Safari id:com.apple.Safari
```

The first column includes the application name and the second column includes the application's bundle ID.

SendKeys will use `--application-name` to activate the first application instance that either matches the full
application name or partially matches the bundle id.

## Prerequisites

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

0 comments on commit 40f49be

Please sign in to comment.