Skip to content

tmux

The community/apps/tmux directory contains files to enable Talon voice control of tmux. It provides commands for controlling tmux sessions, windows, and panes.

The core functionality is defined in these files:

  • tmux.talon: This file contains Talon commands for pane management, using the user.splits and user.tabs tags. It also contains a note about a required configuration file for detecting when tmux is active. The commands in this file rely on actions defined in tmux.py. For example, go split <user.arrow_key> will use the user.tmux_keybind action to send the appropriate keys to move between panes, while go split will display the panes.

  • tmux.py: This file defines the core Python logic for tmux control. It sets up the tmux app context, and defines the actions that are used by the commands in tmux.talon and tmux_linux.talon. These actions include:

    • tmux_prefix: Sends the tmux prefix key (default ctrl-b).
    • tmux_keybind: Sends the prefix key followed by another key.
    • tmux_enter_command: Enters tmux command mode, and optionally enters a command (without executing it).
    • tmux_execute_command: Enters tmux command mode, enters a command and executes it.
    • tmux_execute_command_with_confirmation: Executes a tmux command that requires confirmation.
    • Overrides of app.tab_open, app.tab_next, and app.tab_previous, to control tmux windows as though they were tabs.
    • Overrides of user actions to control tmux splits and switch between panes. For example, split_window_right creates a split to the right, and then swaps the new pane to the bottom of the pane stack, effectively moving it to the right of the active pane.

  • tmux_linux.talon: This file defines commands for Linux that use a more traditional method for controlling tmux using direct keybinds and tmux commands. It provides a mux command prefix which can be used to execute a variety of tmux actions, such as creating new sessions or windows, switching between panes, renaming sessions, or killing windows or panes. The mux command prefix also has variations that insert the equivalent tmux command into the terminal rather than sending keybinds. For example, mux new session inserts tmux new into the terminal, so that the user can enter the rest of the command.

The tmux.py file defines a context which applies only when the active app is tmux. This allows overriding the default actions defined in Talon (for example, the behavior of tab switching). The tmux.talon file provides a basic set of commands for controlling panes, while the tmux_linux.talon provides a more comprehensive set of commands for controlling all aspects of tmux when running on Linux. All of the commands in these .talon files rely on the actions defined in tmux.py.

In summary, these files provide a comprehensive set of tools for controlling tmux with Talon. They provide basic pane control, tab control, and session control functionality. The tmux.py file is the most important, as it defines the underlying actions for all of the commands.