Commands
press-keys
Commands
press-keys
Simulate typing a keyboard combination.
Description
The press-keys command is used to simulate typing a keyboard combination. This is useful for triggering shortcuts or interacting with applications via keyboard input.
Arguments
| Argument | Type | Description |
|---|---|---|
keys | YAML sequence of strings | A list of keys to press together. Keys are automatically remapped for different operating systems. |
There is a breaking change in v5 that updates the syntax of
press-keys. See Example usage below and if you aren’t sure which version you are running, see Checking the versionExample usage
Protips
- Use this command to trigger system-wide or application-specific shortcuts, such as opening Spotlight on macOS or the Start menu on Windows.
- Ensure the keys specified are valid and supported by the operating system or application.
Gotchas
- The syntax of the
press-keyscommand differs fromv4tov5. Make note of which version you are using and write commands accordingly. - Key mappings may differ between operating systems. For example,
commandon macOS is remapped toctrlon Windows. - Ensure the application or system is in focus when using this command to avoid unexpected behavior.
Notes
- The
press-keyscommand is ideal for automating workflows that rely on keyboard shortcuts.
This command supports cross-platform key remapping to ensure compatibility across macOS, Windows, and Linux.