-
Notifications
You must be signed in to change notification settings - Fork 0
/
Actions.txt
1625 lines (1623 loc) · 61.1 KB
/
Actions.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
app.bundle() -> str
Get active app's bundle identifier
app.executable() -> str
Get active app's executable name
app.name() -> str
Get active app's name
app.notify(body: str = '', title: str = '', subtitle: str = '', sound: bool = False)
Show a desktop notification
app.path() -> str
Get active app's file path
app.preferences()
Open app preferences
app.tab_close()
Close the current tab
app.tab_detach()
Move the current tab to a new window
app.tab_next()
Switch to next tab for this window
app.tab_open()
Open a new tab
app.tab_previous()
Switch to previous tab for this window
app.tab_reopen()
Re-open the last-closed tab
app.window_close()
Close the current window
app.window_hide()
Hide the current window
app.window_hide_others()
Hide all other windows
app.window_next()
Switch to next window for this app
app.window_open()
Open a new window
app.window_previous()
Switch to previous window for this app
browser.address() -> str
Get page URL
browser.bookmark()
Bookmark the current page
browser.bookmark_tabs()
Bookmark all open tabs
browser.bookmarks()
Open the Bookmarks editor
browser.bookmarks_bar()
Toggle the bookmarks bar
browser.focus_address()
Focus address bar
browser.focus_page()
Focus the page body
browser.focus_search()
Focus the search box
browser.go(url: str)
Go to a new URL
browser.go_back()
Go back in the history
browser.go_blank()
Go to a blank page
browser.go_forward()
Go forward in the history
browser.go_home()
Go to home page
browser.open_private_window()
Open a private browsing window
browser.reload()
Reload current page
browser.reload_hard()
Reload current page (harder)
browser.reload_hardest()
Reload current page (hardest)
browser.show_clear_cache()
Show 'Clear Cache' dialog
browser.show_downloads()
Show download list
browser.show_extensions()
Show installed extensions
browser.show_history()
Show recently visited pages
browser.submit_form()
Submit the current form
browser.title() -> str
Get page title
browser.toggle_dev_tools()
Open or close the developer tools
clip.capture_text(key: str)
Send key sequence and return resulting clipboard text
clip.clear() -> None
Clear clipboard contents
clip.image() -> Optional[talon.skia.image.Image]
Get clipboard image
clip.set_image(image: talon.skia.image.Image)
Set clipboard image
clip.set_text(text: str)
Set clipboard text
clip.text() -> str
Get clipboard text
code.complete()
Trigger code autocomplete
code.extend_scope_end()
Extend selection to end of current scope
code.extend_scope_in()
Extend selection to start of first inner scope
code.extend_scope_next()
Extend selection to start of next sibling scope
code.extend_scope_out()
Extend selection to start of outer scope
code.extend_scope_previous()
Extend selection to start of previous sibling scope
code.extend_scope_start()
Extend selection to start of current scope
code.language() -> str
Return the active programming language
code.rename(name: str)
Rename selection to <name>
code.scope_end()
Move cursor to end of current scope
code.scope_in()
Move cursor to start of first inner scope
code.scope_next()
Move cursor to start of next sibling scope
code.scope_out()
Move cursor to start of outer scope
code.scope_previous()
Move cursor to start of previous sibling scope
code.scope_start()
Move cursor to start of current scope
code.select_scope()
Select scope under cursor
code.toggle_comment()
Toggle comments on the current line(s)
core.cancel_phrase__unstable()
Cancel the currently running phrase
core.current_command__unstable() -> tuple[talon.scripting.types.CommandImpl, talon.grammar.vm.Capture]
Return the currently executing command
core.last_command() -> tuple[talon.scripting.types.CommandImpl, talon.grammar.vm.Capture]
Return the last executed command
core.last_phrase() -> talon.grammar.vm.Capture
Return the last-spoken phrase
core.recent_commands() -> Sequence[Sequence[tuple[talon.scripting.types.CommandImpl, talon.grammar.vm.Capture]]]
Return recently executed commands (grouped by phrase)
core.recent_phrases() -> Sequence[talon.grammar.vm.Capture]
Return recently-spoken phrases
core.repeat_command(times: int = 1)
Repeat the last command N times
core.repeat_partial_phrase(times: int = 1)
Repeat the previous phrase or current partial phrase N times
core.repeat_phrase(times: int = 1)
Repeat the last phrase N times
core.replace_command(commands: Sequence[tuple[talon.scripting.types.CommandImpl, talon.grammar.vm.Capture]])
Replace the current command in history with one or more commands
core.run_command(cmd: talon.scripting.types.CommandImpl, m: talon.grammar.vm.Capture)
Run a single command for a recognized phrase
core.run_hotkey(hotkey: talon.scripting.types.ScriptImpl)
Run all commands for a hotkey
core.run_phrase(phrase: talon.grammar.vm.Capture)
Run all commands for a recognized phrase
core.run_talon_script(ctx: talon.scripting.rctx.ResourceContext, script: talon.scripting.talon_script.TalonScript, m: talon.grammar.vm.Capture)
Run a single TalonScript for a recognized phrase
dictate.join_words(words: Sequence[str], separator: str = ' ') -> str
Join a list of words into a single string for insertion
dictate.lower(p: talon.grammar.vm.Phrase)
Insert lowercase text with auto_insert()
dictate.natural(p: talon.grammar.vm.Phrase)
Insert naturally-capitalized text with auto_insert()
dictate.parse_words(p: talon.grammar.vm.Phrase) -> Sequence[str]
Extract words from a spoken Capture
dictate.replace_words(words: Sequence[str]) -> Sequence[str]
Replace words according to the dictate.word_map dictionary setting
edit.copy()
Copy selection to clipboard
edit.cut()
Cut selection to clipboard
edit.delete()
Delete selection
edit.delete_line()
Delete line under cursor
edit.delete_paragraph()
Delete paragraph under cursor
edit.delete_sentence()
Delete sentence under cursor
edit.delete_word()
Delete word under cursor
edit.down()
Move cursor down one row
edit.extend_again()
Extend selection again in the same way
edit.extend_column(n: int)
Extend selection to column <n>
edit.extend_down()
Extend selection down one row
edit.extend_file_end()
Extend selection to end of file
edit.extend_file_start()
Extend selection to start of file
edit.extend_left()
Extend selection left one column
edit.extend_line(n: int)
Extend selection to include line <n>
edit.extend_line_down()
Extend selection down one full line
edit.extend_line_end()
Extend selection to end of line
edit.extend_line_start()
Extend selection to start of line
edit.extend_line_up()
Extend selection up one full line
edit.extend_page_down()
Extend selection down one page
edit.extend_page_up()
Extend selection up one page
edit.extend_paragraph_end()
Extend selection to the end of the current paragraph
edit.extend_paragraph_next()
Extend selection to the start of the next paragraph
edit.extend_paragraph_previous()
Extend selection to the start of the previous paragraph
edit.extend_paragraph_start()
Extend selection to the start of the current paragraph
edit.extend_right()
Extend selection right one column
edit.extend_sentence_end()
Extend selection to the end of the current sentence
edit.extend_sentence_next()
Extend selection to the start of the next sentence
edit.extend_sentence_previous()
Extend selection to the start of the previous sentence
edit.extend_sentence_start()
Extend selection to the start of the current sentence
edit.extend_up()
Extend selection up one row
edit.extend_word_left()
Extend selection left one word
edit.extend_word_right()
Extend selection right one word
edit.file_end()
Move cursor to end of file (start of line)
edit.file_start()
Move cursor to start of file
edit.find(text: str = None)
Open Find dialog, optionally searching for text
edit.find_next()
Select next Find result
edit.find_previous()
Select previous Find result
edit.indent_less()
Remove a tab stop of indentation
edit.indent_more()
Add a tab stop of indentation
edit.jump_column(n: int)
Move cursor to column <n>
edit.jump_line(n: int)
Move cursor to line <n>
edit.left()
Move cursor left one column
edit.line_clone()
Create a new line identical to the current line
edit.line_down()
Move cursor to start of line below
edit.line_end()
Move cursor to end of line
edit.line_insert_down()
Insert line below cursor
edit.line_insert_up()
Insert line above cursor
edit.line_start()
Move cursor to start of line
edit.line_swap_down()
Swap the current line with the line below
edit.line_swap_up()
Swap the current line with the line above
edit.line_up()
Move cursor to start of line above
edit.move_again()
Move cursor again in the same way
edit.page_down()
Move cursor down one page
edit.page_up()
Move cursor up one page
edit.paragraph_end()
Move cursor to the end of the current paragraph
edit.paragraph_next()
Move cursor to the start of the next paragraph
edit.paragraph_previous()
Move cursor to the start of the previous paragraph
edit.paragraph_start()
Move cursor to the start of the current paragraph
edit.paste()
Paste clipboard at cursor
edit.paste_match_style()
Paste clipboard without style information
edit.print()
Open print dialog
edit.redo()
Redo
edit.right()
Move cursor right one column
edit.save()
Save current document
edit.save_all()
Save all open documents
edit.select_all()
Select all text in the current document
edit.select_line(n: int = None)
Select entire line <n>, or current line
edit.select_lines(a: int, b: int)
Select entire lines from <a> to <b>
edit.select_none()
Clear current selection
edit.select_paragraph()
Select the entire nearest paragraph
edit.select_sentence()
Select the entire nearest sentence
edit.select_word()
Select word under cursor
edit.selected_text() -> str
Get currently selected text
edit.selection_clone()
Insert a copy of the current selection
edit.sentence_end()
Move cursor to the end of the current sentence
edit.sentence_next()
Move cursor to the start of the next sentence
edit.sentence_previous()
Move cursor to the start of the previous sentence
edit.sentence_start()
Move cursor to the start of the current sentence
edit.undo()
Undo
edit.up()
Move cursor up one row
edit.word_left()
Move cursor left one word
edit.word_right()
Move cursor right one word
edit.zoom_in()
Zoom in
edit.zoom_out()
Zoom out
edit.zoom_reset()
Zoom to original size
auto_format(text: str) -> str
Apply text formatting, such as auto spacing, for the native language
auto_insert(text: str)
Insert text at the current cursor position, automatically formatting it using the actions.auto_format(text)
insert(text: str)
Insert text at the current cursor position
key(key: str)
Press one or more keys by name, space-separated
mimic(text: str)
Simulate speaking {text}
mouse_click(button: int = 0)
Press and release a mouse button
mouse_drag(button: int = 0)
Hold down a mouse button
mouse_move(x: float, y: float)
Move mouse to (x, y) coordinate
mouse_release(button: int = 0)
Release a mouse button
mouse_scroll(y: float = 0, x: float = 0, by_lines: bool = False)
Scroll the mouse wheel
mouse_x() -> float
Mouse X position
mouse_y() -> float
Mouse Y position
print(obj: Any)
Display an object in the log
skip()
Do nothing
sleep(duration: Union[float, str])
Pause for some duration.
If you use a number, it is seconds, e.g 1.5 seconds or 0.001 seconds.
If you use a string, it is a timespec, such as "50ms" or "10s"
For performance reasons, sleep() cannot be reimplemented by a Context.
migrate.backup_user()
Backup the .talon/user/ directory to a zip file in .talon/backups/
migrate.v02_all(prefix: str = '', verbose: bool = False)
Perform migrations for Talon v0.2 on all files in user/
migrate.v02_one(path: str, verbose: bool = False)
Migrate action() definitions from a .talon file to a new Python file.
mode.disable(mode: str)
Disable a mode
mode.enable(mode: str)
Enable a mode
mode.restore()
Restore saved modes
mode.save()
Save all active modes
mode.toggle(mode: str)
Toggle a mode
path.talon_app() -> str
Path to Talon application
path.talon_home() -> str
Path to home/.talon
path.talon_user() -> str
Path to Talon user
path.user_home() -> str
Path to user home
speech.disable()
Disable speech recognition
speech.enable()
Enable speech recognition
speech.enabled() -> bool
Test if speech recognition is enabled
speech.record_flac()
Record the phrase audio to a flac file
speech.record_wav()
Record the phrase audio to a wave file
speech.replay(path: str)
Replay a .flac or .wav file into the speech engine
speech.set_microphone(name: str)
Set the currently active microphone - DEPRECATED: use sound.set_microphone()
speech.toggle(value: bool = None)
Toggle speech recognition
sound.active_microphone() -> str
Return active microphone name
sound.microphones() -> Sequence[str]
Return a list of available microphone names
sound.set_microphone(name: str)
Set the currently active microphone
win.file_ext() -> str
Return the open file's extension
win.filename() -> str
Return the open filename
win.title() -> str
Get window title
tracking.calibrate() -> None
Calibrate Eye Tracking
tracking.control1_enabled() -> bool
Is Control Mouse (Legacy) Enabled?
tracking.control1_toggle(state: bool = None) -> None
Toggle Control Mouse (Legacy)
tracking.control_debug_toggle(state: bool = None) -> None
Toggle Control Mouse 2 (Debug View)
tracking.control_enabled() -> bool
Is Control Mouse Enabled?
tracking.control_gaze_focus_toggle(state: bool = None) -> None
Toggle Control Mouse 2 (Gaze Focus)
tracking.control_gaze_scroll_toggle(state: bool = None) -> None
Toggle Control Mouse 2 (Gaze Scroll)
tracking.control_gaze_toggle(state: bool = None) -> None
Toggle Control Mouse 2 (Gaze Control)
tracking.control_head_toggle(state: bool = None) -> None
Toggle Control Mouse 2 (Head Control)
tracking.control_mouse_jump_toggle(state: bool = None) -> None
Toggle Control Mouse 2 (Mouse Jump)
tracking.control_toggle(state: bool = None) -> None
Toggle Control Mouse
tracking.control_zoom_enabled() -> bool
Is Control Mouse (Zoom) Enabled?
tracking.control_zoom_toggle(state: bool = None) -> None
Toggle Control Mouse (Zoom)
tracking.zoom() -> None
Trigger Eye Zoom / Click
tracking.zoom_cancel() -> None
Cancel Eye Zoom
menu.check_for_updates()
Check for updates
menu.open_debug_window()
Open Debug window
menu.open_log()
Open Talon log
menu.open_repl()
Open Talon REPL
menu.open_talon_home()
Open Talon config folder
user.password_delete()
Delete password
user.password_duplicate()
Duplicate password
user.password_edit()
Edit password
user.password_fill()
fill the password
user.password_new()
New password
user.password_show()
show the password
user.chrome_mod(key: str)
Press the specified key with the correct modifier key for the OS
user.discord_answer_call()
Answer incoming call
user.discord_deafen()
Toggle deafen
user.discord_decline_call()
Decline incoming call
user.discord_emoji_picker()
Toggle emoji picker
user.discord_gif_picker()
Toggle gif picker
user.discord_go_current_call()
Go to current call
user.discord_mark_inbox_read()
Mark top inbox channel read
user.discord_mentions_last()
Go up to channel with unread mentions
user.discord_mentions_next()
Go down to channel with unread mentions
user.discord_mute()
Toggle mute
user.discord_oldest_unread()
Go to oldest unread message
user.discord_quick_switcher(dest_type: str, dest_search: str)
Open up the quick switcher, optionally specifying a type of destination
user.discord_sticker_picker()
Toggle sticker picker
user.discord_toggle_dms()
Toggle between dms and your most recent server
user.discord_toggle_inbox()
Toggle inbox popout
user.discord_toggle_members()
Toggle channel member list
user.discord_toggle_pins()
Toggle pins popout
user.emacs(command_name: str, prefix: Optional[int] = None)
Runs the emacs command `command_name`. Defaults to using M-x, but may use
a key binding if known or rpc if available. Provides numeric prefix argument
`prefix` if specified.
user.emacs_help(key: str = None)
Runs the emacs help command prefix, optionally followed by some keys.
user.emacs_key(keys: str)
Presses some keys, translating 'meta-' prefix to the appropriate keys. For
example, if the setting user.emacs_meta = 'esc', user.emacs_key("meta-ctrl-a")
becomes key("esc ctrl-a").
user.emacs_meta(key: str)
Presses some keys modified by Emacs' meta key.
user.emacs_prefix(n: Optional[int] = None)
Inputs a prefix argument.
user.emacs_command_keybinding(command_name: str) -> Optional[str]
Looks up the keybinding for command_name in emacs_commands.csv.
user.emacs_command_short_form(command_name: str) -> Optional[str]
Looks up the short form for command_name in emacs_commands.csv.
user.firefox_bookmarks_sidebar()
Toggles the Firefox bookmark sidebar
user.firefox_history_sidebar()
Toggles the Firefox history sidebar
user.gdb_disable()
Disables the gdb tag
user.gdb_enable()
Enables the gdb tag
user.i3wm_float()
Toggle whether the focused container should float.
user.i3wm_focus(what: str)
Move focus
user.i3wm_fullscreen()
Fullscreen the current container
user.i3wm_launch()
Trigger the i3 launcher: ex rofi
user.i3wm_layout(layout: Optional[str] = None)
Change to specified layout. Toggle split if unspecified.
user.i3wm_lock()
Trigger the lock screen
user.i3wm_mode(name: str)
Switch i3 mode
user.i3wm_move(to: str)
Move the focused container
user.i3wm_move_position(where: str)
Move the focused container to the specified position.
user.i3wm_move_to_output(which: str)
Move the focused container to the specified output.
user.i3wm_move_to_workspace(which: Union[str, int])
Move the focused container to the specified workspace
user.i3wm_reload()
Reload the i3 config
user.i3wm_restart()
Restart the window manager
user.i3wm_shell()
Launch a shell
user.i3wm_show_scratchpad()
Focus/cycle/hide the scratchpad
user.i3wm_split(direction: str)
Split the focused container
user.i3wm_switch_to_workspace(which: Union[str, int])
Focus the specified workspace
user.idea(commands: str)
Send a command to Jetbrains product
user.idea_grab(times: int)
Copies specified number of words to the left
user.overview_tabs()
Toggle tab overview in Orion
user.thunderbird_calendar_view(number: int)
Select between calendar view tabs
user.thunderbird_mod(keys: str)
Press keys with modifier ctrl or cmd
user.tmux_enter_command(command: str = '')
Enter tmux command mode and optionally insert a command without executing it.
user.tmux_execute_command(command: str)
execute tmux command
user.tmux_execute_command_with_confirmation(command: str, confirmation_prompt: str)
execute tmux command with confirm-before
user.tmux_keybind(key: str)
press tmux prefix followed by a key bind
user.tmux_prefix()
press control and the configured tmux prefix key
user.vivaldi_bookmarks_panel()
Toggles the Vivaldi bookmarks panel
user.vivaldi_downloads_panel()
Toggles the Vivaldi downloads panel
user.vivaldi_history_panel()
Toggles the Vivaldi history panel
user.vivaldi_notes_panel()
Toggles the Vivaldi notes panel
user.vivaldi_toggle_quick_commands()
Toggles the Vivaldi Quick Commands tool
user.command_server_directory() -> str
The dirctory which contains the files required for communication between
the application and Talon. This is the only function which absolutely
must be implemented for any application using the command-client. Each
application that supports file-based RPC should use its own directory
name. Note that this action should only return a name; the parent
directory is determined by the core command client code.
user.did_emit_pre_phrase_signal() -> bool
Indicates whether the pre-phrase signal was emitted at the start of this phrase
user.emit_pre_phrase_signal() -> bool
If in an application supporting the command client, returns True
and touches a file to indicate that a phrase is beginning execution.
Otherwise does nothing and returns False.
user.run_rpc_command(command_id: str, arg1: Any = <class 'user.community.apps.vscode.command_client.command_client.NotSet'>, arg2: Any = <class 'user.community.apps.vscode.command_client.command_client.NotSet'>, arg3: Any = <class 'user.community.apps.vscode.command_client.command_client.NotSet'>, arg4: Any = <class 'user.community.apps.vscode.command_client.command_client.NotSet'>, arg5: Any = <class 'user.community.apps.vscode.command_client.command_client.NotSet'>)
Execute command via RPC.
user.run_rpc_command_and_wait(command_id: str, arg1: Any = <class 'user.community.apps.vscode.command_client.command_client.NotSet'>, arg2: Any = <class 'user.community.apps.vscode.command_client.command_client.NotSet'>, arg3: Any = <class 'user.community.apps.vscode.command_client.command_client.NotSet'>, arg4: Any = <class 'user.community.apps.vscode.command_client.command_client.NotSet'>, arg5: Any = <class 'user.community.apps.vscode.command_client.command_client.NotSet'>)
Execute command via application command server and wait for command to finish.
user.run_rpc_command_get(command_id: str, arg1: Any = <class 'user.community.apps.vscode.command_client.command_client.NotSet'>, arg2: Any = <class 'user.community.apps.vscode.command_client.command_client.NotSet'>, arg3: Any = <class 'user.community.apps.vscode.command_client.command_client.NotSet'>, arg4: Any = <class 'user.community.apps.vscode.command_client.command_client.NotSet'>, arg5: Any = <class 'user.community.apps.vscode.command_client.command_client.NotSet'>) -> Any
Execute command via application command server and return command output.
user.trigger_command_server_command_execution()
Issue keystroke to trigger command server to execute command that
was written to the file. For internal use only
user.vscode(command_id: str)
Execute command via vscode command server, if available, or fallback
to command palette.
user.vscode_and_wait(command_id: str)
Execute command via vscode command server, if available, and wait
for command to finish. If command server not available, uses command
palette and doesn't guarantee that it will wait for command to
finish.
user.vscode_get(command_id: str, arg1: Any = <class 'user.community.apps.vscode.command_client.command_client.NotSet'>, arg2: Any = <class 'user.community.apps.vscode.command_client.command_client.NotSet'>, arg3: Any = <class 'user.community.apps.vscode.command_client.command_client.NotSet'>, arg4: Any = <class 'user.community.apps.vscode.command_client.command_client.NotSet'>, arg5: Any = <class 'user.community.apps.vscode.command_client.command_client.NotSet'>) -> Any
Execute command via vscode command server and return command output.
user.vscode_with_plugin(command_id: str, arg1: Any = <class 'user.community.apps.vscode.command_client.command_client.NotSet'>, arg2: Any = <class 'user.community.apps.vscode.command_client.command_client.NotSet'>, arg3: Any = <class 'user.community.apps.vscode.command_client.command_client.NotSet'>, arg4: Any = <class 'user.community.apps.vscode.command_client.command_client.NotSet'>, arg5: Any = <class 'user.community.apps.vscode.command_client.command_client.NotSet'>)
Execute command via vscode command server.
user.vscode_with_plugin_and_wait(command_id: str, arg1: Any = <class 'user.community.apps.vscode.command_client.command_client.NotSet'>, arg2: Any = <class 'user.community.apps.vscode.command_client.command_client.NotSet'>, arg3: Any = <class 'user.community.apps.vscode.command_client.command_client.NotSet'>, arg4: Any = <class 'user.community.apps.vscode.command_client.command_client.NotSet'>, arg5: Any = <class 'user.community.apps.vscode.command_client.command_client.NotSet'>)
Execute command via vscode command server and wait for command to finish.
user.command_palette()
Show command palette
user.vscode_terminal(number: int)
Activate a terminal by number
user.windbg_disable()
Disables the windbg tag
user.windbg_enable()
Enables the windbg tag
user.wsl_reset_path_detection()
reset wsl path detection
user.wsl_speak()
ask each distro to say hello (in the log)
user.get_running_app(name: str) -> talon.windows.ui.App
Get the first available running app with `name`.
user.switcher_focus(name: str)
Focus a new application by name
user.switcher_focus_app(app: talon.windows.ui.App)
Focus application and wait until switch is made
user.switcher_focus_window(window: talon.windows.ui.Window)
Focus window and wait until switch is made
user.switcher_hide_running()
Hides list of running applications
user.switcher_launch(path: str)
Launch a new application by path (all OSes), or AppUserModel_ID path on Windows
user.switcher_menu()
Open a menu of running apps to switch to
user.switcher_toggle_running()
Shows/hides all running applications
user.move_cursor(s: str)
Given a sequence of directions, eg. 'left left up', moves the cursor accordingly using edit.{left,right,up,down}.
user.create_spoken_forms(source: str, words_to_exclude: Optional[list[str]] = None, minimum_term_length: int = 2, generate_subsequences: bool = True) -> list[str]
Create spoken forms for a given source
user.create_spoken_forms_from_list(sources: list[str], words_to_exclude: Optional[list[str]] = None, minimum_term_length: int = 2, generate_subsequences: bool = True) -> dict[str, str]
Create spoken forms for all sources in a list, doing conflict resolution
user.create_spoken_forms_from_map(sources: Mapping[str, Any], words_to_exclude: Optional[list[str]] = None, minimum_term_length: int = 2, generate_subsequences: bool = True) -> dict[str, typing.Any]
Create spoken forms for all sources in a map, doing conflict resolution
user.delayed_speech_off()
Disables "temporary speech" mode lazily, meaning that the next
phrase that finishes will turn speech off.
user.delayed_speech_on()
Activates a "temporary speech" mode that can be disabled lazily,
so that the actual disable command happens after whatever phrase
finishes next.
user.deprecate_action(time_deprecated: str, name: str)
Notify the user that the given action is deprecated and should
not be used into the future.
user.deprecate_capture(time_deprecated: str, name: str)
Notify the user that the given capture is deprecated and should
not be used into the future.
user.deprecate_command(time_deprecated: str, name: str, replacement: str)
Notify the user that the given voice command is deprecated and should
not be used into the future; the command `replacement` should be used
instead.
user.copy_all()
Copy all text in the current document
user.copy_line()
Copy current line
user.copy_line_end()
Copy to end of current line
user.copy_line_start()
Copy to start of current line
user.copy_word()
Copy word under cursor
user.copy_word_left()
Copies the word to the left.
user.copy_word_right()
Copies the word to the right.
user.cut_all()
Cut all text in the current document
user.cut_line()
Cut current line
user.cut_line_end()
Cut to end of current line
user.cut_line_start()
Cut to start of current line
user.cut_word()
Cut word under cursor
user.cut_word_left()
Cuts the word to the left.
user.cut_word_right()
Cuts the word to the right.
user.delete_all()
Delete all text in the current document
user.delete_line_end()
Delete to end of current line
user.delete_line_start()
Delete to start of current line
user.delete_right()
Delete character to the right
user.paste(text: str)
Pastes text and preserves clipboard
user.paste_all()
Paste to the current document
user.paste_line()
Paste to current line
user.paste_line_end()
Paste to end of current line
user.paste_line_start()
Paste to start of current line
user.paste_word()
Paste to word under cursor
user.select_line_end()
Select to end of current line
user.select_line_start()
Select to start of current line
user.words_left(n: int)
Moves left by n words.
user.words_right(n: int)
Moves right by n words.
user.insert_between(before: str, after: str)
Insert `before + after`, leaving cursor between `before` and `after`. Not entirely reliable if `after` contains newlines.
user.insert_cursor(text: str)
Insert a string. Leave the cursor wherever [|] is in the text
user.edit_text_file(path: str)
Tries to open a file in the user's preferred text editor.
user.engine_mimic(cmd: str)
Sends phrase to engine
user.engine_sleep()
Sleep the engine
user.engine_wake()
Wake the engine
user.help_context()
Display contextual command info
user.help_context_enabled()
Display contextual command info
user.help_formatters(ab: dict)
Provides the list of formatter keywords
user.help_hide()
Hides the help
user.help_list(ab: str)
Provides the symbol dictionary
user.help_next()
Navigates to next page
user.help_previous()
Navigates to previous page
user.help_refresh()
Refreshes the help
user.help_return()
Returns to the main help window
user.help_search(phrase: str)
Display command info for search phrase
user.help_select_index(index: int)
Select the context by a number
user.help_selected_context(m: str)
Display command info for selected context
user.help_scope_toggle()
Toggle help scope gui
user.homophones_force_show(m: str)
Show the homophones display forcibly
user.homophones_force_show_selection()
Show the homophones display for the selected text forcibly
user.homophones_get(word: str) -> [<class 'str'>]
Get homophones for the given word
user.homophones_hide()
Hides the homophones display
user.homophones_select(number: int) -> str
selects the homophone by number
user.homophones_show(m: str)
Show the homophones display
user.homophones_show_auto()
Show homophones for selection, or current word if selection is empty.
user.homophones_show_selection()
Show the homophones display for the selected text
user.code_clear_language_mode()
Clears the active language mode, and re-enables code.language: extension matching
user.code_set_language_mode(language: str)
Sets the active language mode, and disables extension matching
user.dragon_mode()
For windows and Mac with Dragon, disables Talon commands and exits Dragon's command mode
user.talon_mode()
For windows and Mac with Dragon, enables Talon commands and Dragon's command mode.
user.grid_activate()
Show mouse grid
user.grid_close()
Close the active grid
user.grid_go_back()
Sets the grid state back to what it was before the last command
user.grid_narrow(digit: Union[int, str])
Choose a field of the grid and narrow the selection down
user.grid_narrow_list(digit_list: list[str])
Choose fields multiple times in a row
user.grid_place_window()
Places the grid on the currently active window
user.grid_reset()
Resets the grid to fill the whole screen again
user.grid_select_screen(screen: int)
Brings up mouse grid
user.noise_trigger_hiss(active: bool)
Called when the user makes a 'hiss' noise. Listen to
https://noise.talonvoice.com/static/previews/hiss.mp3 for an
example.
user.noise_trigger_pop()
Called when the user makes a 'pop' noise. Listen to
https://noise.talonvoice.com/static/previews/pop.mp3 for an
example.
user.screens_get_by_number(screen_number: int) -> talon.screen.Screen
Get screen by number
user.screens_get_next(screen: talon.screen.Screen) -> talon.screen.Screen
Get the screen after this one
user.screens_get_previous(screen: talon.screen.Screen) -> talon.screen.Screen
Get the screen before this one
user.screens_show_numbering()
Show screen number on each screen
user.system_command(cmd: str)
execute a command on the system
user.system_command_nb(cmd: str)
execute a command on the system without blocking
user.formatted_text(phrase: Union[str, talon.grammar.vm.Phrase], formatters: str) -> str
Formats a phrase according to formatters. formatters is a comma-separated string of formatters (e.g. 'CAPITALIZE_ALL_WORDS,DOUBLE_QUOTED_STRING')
user.formatters_reformat_last(formatters: str) -> str
Clears and reformats last formatted phrase
user.formatters_reformat_selection(formatters: str) -> str
Reformats the current selection.
user.get_formatters_words() -> dict
returns a list of words currently used as formatters, and a demonstration string using those formatters
user.insert_formatted(phrase: Union[str, talon.grammar.vm.Phrase], formatters: str)
Inserts a phrase formatted according to formatters. Formatters is a comma separated list of formatters (e.g. 'CAPITALIZE_ALL_WORDS,DOUBLE_QUOTED_STRING')
user.insert_many(strings: list[str]) -> None
Insert a list of strings, sequentially.
user.insert_with_history(text: str)
Inserts some text, remembering it in the phrase history.
user.reformat_text(text: str, formatters: str) -> str
Reformat the text.
user.add_phrase_to_history(text: str)
Adds a phrase to the phrase history
user.before_last_phrase()
Moves left before the last phrase
user.clear_last_phrase()
Clears the last phrase
user.get_last_phrase() -> str
Gets the last phrase
user.get_recent_phrase(number: int) -> str
Gets the nth most recent phrase
user.phrase_history_hide()
Hides the recent phrases window
user.select_last_phrase()
Selects the last phrase
user.toggle_phrase_history()
Toggles list of recent phrases
user.dictation_format_cap()
Sets the dictation formatter to capitalize
user.dictation_format_no_cap()
Sets the dictation formatter to not capitalize
user.dictation_format_no_space()
Sets the dictation formatter to not prepend a space
user.dictation_format_reset()
Resets the dictation formatter
user.dictation_insert(text: str, auto_cap: bool = True) -> str
Inserts dictated text, formatted appropriately.
user.dictation_insert_raw(text: str)
Inserts text as-is, without invoking the dictation formatter.
user.dictation_peek(left: bool, right: bool) -> tuple[typing.Optional[str], typing.Optional[str]]
Gets text around the cursor to inform auto-spacing and -capitalization.
Returns (before, after), where `before` is some text before the cursor,
and `after` some text after it. Results are not guaranteed; `before`
and/or `after` may be None, indicating no information. If `before` is
the empty string, this means there is nothing before the cursor (we are
at the beginning of the document); likewise for `after`.
To optimize performance, pass `left = False` if you won't need
`before`, and `right = False` if you won't need `after`.
dictation_peek() is intended for use before inserting text, so it may
delete any currently selected text.
user.dictation_reformat_cap()
Capitalizes the last utterance
user.dictation_reformat_no_cap()
Lowercases the last utterance
user.dictation_reformat_no_space()
Removes space before the last utterance
user.add_selection_to_vocabulary(phrase: Union[talon.grammar.vm.Phrase, str] = '', type: str = '')
Permanently adds the currently selected text to the vocabulary with the provided
spoken form and adds variants based on the type ("noun" or "name").
user.add_selection_to_words_to_replace(phrase: talon.grammar.vm.Phrase, type: str = '')
Permanently adds the currently selected text as replacement for the provided
original form and adds variants based on the type ("noun" or "name").
user.open_url(url: str)
Visit the given URL.
user.search_with_search_engine(search_template: str, search_text: str)
Search a search engine for given text
user.tab_close_wrapper()
Closes the current tab.
Exists so that apps can implement their own delay before running tab_close() to handle repetitions better.
user.tab_duplicate()
Duplicates the current tab.
user.tab_final()
Jumps to the final tab
user.tab_jump(number: int)
Jumps to the specified tab
user.move_app_to_screen(app_name: str, screen_number: int)
Move a specific application to another screen.
user.move_window_next_screen() -> None
Move the active window to a specific screen.
user.move_window_previous_screen() -> None
Move the active window to the previous screen.
user.move_window_to_screen(screen_number: int) -> None
Move the active window leftward by one.
user.snap_app(app_name: str, position: user.community.core.windows_and_tabs.window_snap.RelativeScreenPos)
Snap a specific application to another screen.
user.snap_window(position: user.community.core.windows_and_tabs.window_snap.RelativeScreenPos) -> None
Move the active window to a specific position on its current screen, given a `RelativeScreenPos` object.
user.snap_window_to_position(position_name: str) -> None
Move the active window to a specifically named position on its current screen, using a key from `_snap_positions`.
user.code_comment_documentation_block()
Inserts a block document comment and positions the cursor appropriately
user.code_comment_documentation_block_inner()
Inserts an inner block document comment and positions the cursor appropriately
user.code_comment_documentation_inner()
Inserts an inner document comment and positions the cursor appropriately
user.code_insert_if_let_error()
Inserts if let error block, positioning the cursor appropriately
user.code_insert_if_let_some()
Inserts if let some block, positioning the cursor appropriately
user.code_insert_macro(text: str, selection: str)
Inserts a macro and positions the cursor appropriately
user.code_insert_macro_array(text: str, selection: str)
Inserts a macro array and positions the cursor appropriately
user.code_insert_macro_block(text: str, selection: str)
Inserts a macro block and positions the cursor appropriately
user.code_insert_return_trait(type: str)
Inserts a return type for implementor of trait
user.code_insert_trait_annotation(type: str)
Inserts type annotation for implementor of trait
user.code_state_implements()
Inserts implements block, positioning the cursor appropriately
user.code_state_unsafe()
Inserts an unsafe block and positions the cursor appropriately
user.code_comment_block()
Block comment
user.code_comment_block_prefix()
Block comment start syntax
user.code_comment_block_suffix()
Block comment end syntax
user.code_comment_documentation()
Inserts a document comment and positions the cursor appropriately
user.code_comment_line_prefix()
Inserts line comment prefix at current cursor location
user.code_insert_false()
Insert False value
user.code_insert_true()
Insert True value
user.code_insert_is_not_null()
Inserts check for non-null
user.code_insert_is_null()
Inserts check for null
user.code_insert_null()
Inserts null
user.code_default_function(text: str)
Inserts function declaration
user.code_insert_named_argument(parameter_name: str)
Inserts a named argument
user.code_insert_return_type(type: str)
Inserts a return type
user.code_insert_type_annotation(type: str)
Inserts a type annotation
user.code_modified_function(modifiers: Union[list[str], int], text: str)
Inserts function declaration with the given modifiers. modifiers == 0
implies no modifiers (.talon files don't have empty list literal
syntax)
user.code_private_function(text: str)
Inserts private function declaration