Skip to content

Add shortcat integration #1940

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
NLCas8 wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Add shortcat integration #1940

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3a47c6e
Add Shortcat functions
NLCas8 Jul 13, 2025
61bc6f2
Add Shortcat commands
NLCas8 Jul 13, 2025
f550022
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jul 13, 2025
4a27a2f
Set Shortcat hotkey to default
NLCas8 Jul 14, 2025
2ea8caf
Replace constants with settings
NLCas8 Jul 14, 2025
3fdee19
Limit to mac only
NLCas8 Jul 14, 2025
a731154
Merge branch 'main' into add-shortcat
nriley Jul 19, 2025
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
40 changes: 40 additions & 0 deletions apps/shortcat/shortcat.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
from talon import Module, actions

mod = Module()

# Hotkey that is configured to activate Shortcat
SHORTCAT_HOTKEY = "cmd-shift-space"

@auscompgeek auscompgeek Jul 14, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This should be a setting so it can be changed by users without modifying the code.

@NLCas8 NLCas8 Jul 14, 2025

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

I replaced both constants with settings

# Delay to wait for Shortcat to show the shortcuts
SHORTCUTS_DELAY = "500ms"


@mod.action_class
class Actions:
def shortcat_hover(text: str):
"Hover over a button using shortcat"
actions.key(SHORTCAT_HOTKEY)
actions.sleep(SHORTCUTS_DELAY)
actions.insert(text)

def shortcat_click(text: str, click_delay: str = "0ms"):
"Click a button using shortcat"
actions.user.shortcat_hover(text)
actions.sleep(click_delay)

@nriley nriley Jul 19, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

From the community backlog session, we had a couple comments on this behavior.

If the delay is to give you time to cancel if the wrong button is about to be clicked, then using actions.sleep will block Talon and not allow you to cancel using a voice command or other Talon action. A couple options:

  • Having a separate confirmation action. This is how my Homerow support works
  • Using cron such that Talon is active while it is waiting.

Our preference is for the first option as we feel that any substantial delay long enough to give you a chance to cancel would be frustrating to use in practice.

actions.key("enter")
actions.sleep("100ms")
actions.mouse_click(0)

def shortcat_double_click(text: str, click_delay: str = "0ms"):
"Double click a button using shortcat"
actions.user.shortcat_hover(text)
actions.sleep(click_delay)
actions.key("enter")
actions.sleep("100ms")
actions.mouse_click(0)
actions.mouse_click(0)

@nriley nriley Jul 19, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Consider using a single action for single and multiple clicks.


def shortcat_right(text: str, click_delay: str = "0ms"):
"Right click a button using shortcat"
actions.user.shortcat_hover(text)
actions.sleep(click_delay)
actions.key("ctrl-enter")
13 changes: 13 additions & 0 deletions apps/shortcat/shortcat.talon
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
^(shot | sot) [<user.text>]: user.shortcat_hover(text or "")

^(shot | sot) click [<user.text>]:
# Add some delay to cancel click if needed
user.shortcat_click(text or "", "1500ms")

@nriley nriley Jul 19, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think that this delay would be incredibly frustrating in practice, not to mention it is likely to trigger Talon's watchdog timer and spam your log. I would recommend that you have this as a configurable setting, if you decide to use the cancel delay rather than a confirmation action.


^(shot | sot) right [<user.text>]:
# Add some delay to cancel right-click if needed
user.shortcat_right(text or "", "1500ms")

^(shot | sot) dub [<user.text>]:
# Add some delay to cancel double-click if needed
user.shortcat_double_click(text or "", "1500ms")