Skip to content

Add Escape command to list of special key commands #693

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
joelzwarrington wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add Escape command to list of special key commands #693

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ There are a few basic types of VHS commands:
- [`Set <Setting> Value`](#settings): set recording settings
- [`Type "<characters>"`](#type): emulate typing
- [`Left`](#arrow-keys) [`Right`](#arrow-keys) [`Up`](#arrow-keys) [`Down`](#arrow-keys): arrow keys
- [`Backspace`](#backspace) [`Enter`](#enter) [`Tab`](#tab) [`Space`](#space): special keys
- [`Escape`](#escape) [`Backspace`](#backspace) [`Enter`](#enter) [`Tab`](#tab) [`Space`](#space): special keys
Copy link
Author

@joelzwarrington joelzwarrington Dec 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be sorted in any way? I just added Escape to the front of the sepcial keys list without much thought.

Copy link
Author

@joelzwarrington joelzwarrington Dec 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also noticed that Delete is missing. Should that be added to?

- [`Ctrl[+Alt][+Shift]+<char>`](#ctrl): press control + key and/or modifier
- [`Sleep <time>`](#sleep): wait for a certain amount of time
- [`Wait[+Screen][+Line] /regex/`](#wait): wait for specific conditions
Expand Down Expand Up @@ -566,6 +566,16 @@ the key press every interval of `<time>`.
Key[@<time>] [count]
```

#### Escape

Press the escape key with the `Escape` command.

```elixir
Escape
```

todo: Add a .gif example of pressing escape
Copy link
Author

@joelzwarrington joelzwarrington Dec 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's unclear what the approach should be to add the .gif, I'd be happy to add an example which demonstrates this command but am unfamiliar with adding the content to stuff.charm.sh


#### Backspace

Press the backspace key with the `Backspace` command.
Expand Down