Add key binding customizations and documentation for feature

Author: dwash96

aider/tui/app.py

@@ -5,7 +5,8 @@
 import queue
 
 from textual.app import App, ComposeResult
-from textual.binding import Binding
+
+# from textual.binding import Binding
 from textual.containers import Vertical
 from textual.theme import Theme
 
@@ -28,8 +29,8 @@ class TUI(App):
 
     BINDINGS = [
         # Binding("ctrl+c", "quit", "Quit", show=True),
-        Binding("ctrl+l", "clear_output", "Clear", show=True),
-        Binding("escape", "interrupt", "Interrupt", show=True),
+        # Binding("ctrl+l", "clear_output", "Clear", show=True),
+        # Binding("escape", "interrupt", "Interrupt", show=True),
     ]
 
     def __init__(self, coder_worker, output_queue, input_queue, args):
@@ -67,6 +68,42 @@ def __init__(self, coder_worker, output_queue, input_queue, args):
             },
         )
 
+        self.bind(
+            self.tui_config["key_bindings"]["newline"], "noop", description="New Line", show=True
+        )
+        self.bind(
+            self.tui_config["key_bindings"]["submit"], "noop", description="Submit", show=True
+        )
+        self.bind(
+            self.tui_config["key_bindings"]["cycle_forward"],
+            "noop",
+            description="Cycle Forward",
+            show=True,
+        )
+        self.bind(
+            self.tui_config["key_bindings"]["cycle_backward"],
+            "noop",
+            description="Cycle Backward",
+            show=True,
+        )
+        self.bind(
+            self.tui_config["key_bindings"]["cancel"], "noop", description="Cancel", show=True
+        )
+
+        self.bind(
+            self.tui_config["key_bindings"]["focus"],
+            "focus_input",
+            description="Focus Input",
+            show=True,
+        )
+        self.bind(
+            self.tui_config["key_bindings"]["stop"], "interrupt", description="Interrupt", show=True
+        )
+        self.bind(
+            self.tui_config["key_bindings"]["clear"], "clear_output", description="Clear", show=True
+        )
+        self.bind(self.tui_config["key_bindings"]["focus"], "quit", description="Quit", show=True)
+
         self.register_theme(BASE_THEME)
         self.theme = "aider"
 
@@ -101,6 +138,12 @@ def _get_config(self):
         if "other" not in config:
             config["other"] = {}
 
+        if "key_bindings" not in config:
+            config["key_bindings"] = {}
+
+        coder = self.worker.coder
+        is_multiline = coder.args.multiline
+
         # Ensure colors dict has all expected keys with default values
         default_colors = {
             "primary": "#00ff5f",
@@ -120,6 +163,18 @@ def _get_config(self):
             },
         }
 
+        default_key_bindings = {
+            "newline": "enter" if is_multiline else "shift+enter",
+            "submit": "shift+enter" if is_multiline else "enter",
+            "stop": "escape",
+            "cycle_forward": "tab",
+            "cycle_backward": "shift+tab",
+            "focus": "ctrl+f",
+            "cancel": "ctrl+c",
+            "clear": "ctrl+l",
+            "quit": "ctrl+q",
+        }
+
         # Merge default colors with user-provided colors
         for key, default_value in default_colors.items():
             if key not in config["colors"]:
@@ -132,6 +187,13 @@ def _get_config(self):
                     if var_key not in config["colors"]["variables"]:
                         config["colors"]["variables"][var_key] = var_default
 
+        for key, default_value in default_key_bindings.items():
+            if key not in config["key_bindings"]:
+                config["key_bindings"][key] = self._encode_keys(default_value)
+
+        for key, value in config["key_bindings"].items():
+            config["key_bindings"][key] = self._encode_keys(value)
+
         return config
 
     def compose(self) -> ComposeResult:
@@ -205,9 +267,11 @@ def update_key_hints(self, generating=False):
         try:
             hints = self.query_one(KeyHints)
             if generating:
-                hints.update("escape to cancel")
+                stop = self.app._decode_keys(self.app.tui_config["key_bindings"]["stop"])
+                hints.update(f"{stop} to cancel")
             else:
-                hints.update("ctrl+s to submit")
+                submit = self.app._decode_keys(self.app.tui_config["key_bindings"]["submit"])
+                hints.update(f"{submit} to submit")
         except Exception:
             pass
 
@@ -381,6 +445,11 @@ def on_input_area_submit(self, message: InputArea.Submit):
 
         self.input_queue.put({"text": user_input})
 
+    def action_focus_input(self) -> None:
+        """Find the input widget and set focus to it."""
+        input_area = self.query_one("#input", InputArea)
+        input_area.focus()
+
     def action_clear_output(self):
         """Clear all output."""
         output_container = self.query_one("#output", OutputContainer)
@@ -413,6 +482,21 @@ def action_quit(self):
         # Delay exit to allow status bar to render
         self.set_timer(0.3, self._do_quit)
 
+    def action_noop(self):
+        pass
+
+    def _encode_keys(self, key):
+        if key == "shift+enter":
+            return "ctrl+j"
+
+        return key
+
+    def _decode_keys(self, key):
+        if key == "ctrl+j":
+            return "shift+enter"
+
+        return key
+
     def _do_quit(self):
         """Perform the actual quit after UI updates."""
         self.worker.stop()
@@ -653,6 +737,14 @@ def on_input_area_completion_cycle(self, message: InputArea.CompletionCycle):
         except Exception:
             pass
 
+    def on_input_area_completion_cycle_previous(self, message: InputArea.CompletionCyclePrevious):
+        """Handle Tab to cycle through completions."""
+        try:
+            completion_bar = self.query_one("#completion-bar", CompletionBar)
+            completion_bar.cycle_previous()
+        except Exception:
+            pass
+
     def on_input_area_completion_accept(self, message: InputArea.CompletionAccept):
         """Handle Enter to accept current completion."""
         try:

aider/tui/widgets/completion_bar.py

@@ -280,6 +280,15 @@ def cycle_next(self) -> None:
             self.selected_index = (self.selected_index + 1) % len(self.suggestions)
             self._update_selection()
 
+    def cycle_previous(self) -> None:
+        """Cycle to next suggestion."""
+        if self.suggestions:
+            if not self.selected_index:
+                self.selected_index = len(self.suggestions) - 1
+            else:
+                self.selected_index = (self.selected_index - 1) % len(self.suggestions)
+            self._update_selection()
+
     def select_current(self) -> None:
         """Select current suggestion and dismiss."""
         if self.suggestions:

aider/tui/widgets/input_area.py

@@ -27,6 +27,11 @@ class CompletionCycle(Message):
 
         pass
 
+    class CompletionCyclePrevious(Message):
+        """User wants to cycle through completions backwards."""
+
+        pass
+
     class CompletionAccept(Message):
         """User wants to accept current completion."""
 
@@ -54,7 +59,12 @@ def __init__(self, history_file: str = None, **kwargs):
         # Let's assume kwargs might handle it or we set it.
         # Actually, let's just set the default if it's empty.
         if not self.placeholder:
-            self.placeholder = "> Type your message... (ctrl+s to submit, enter for new line)"
+            submit = self.app._decode_keys(self.app.tui_config["key_bindings"]["submit"])
+            newline = self.app._decode_keys(self.app.tui_config["key_bindings"]["newline"])
+
+            self.placeholder = (
+                f"> Type your message... ({submit} to submit, {newline} for new line)"
+            )
 
         self.files = []
         self.commands = []
@@ -198,32 +208,38 @@ def on_key(self, event) -> None:
         if self.disabled:
             return
 
-        if event.key == "ctrl+c":
+        if event.key == self.app.tui_config["key_bindings"]["cancel"]:
             event.stop()
             event.prevent_default()
             if self.text.strip():
                 self.save_to_history(self.text)
             self.text = ""
             return
 
-        if event.key == "ctrl+s":
+        if event.key == self.app.tui_config["key_bindings"]["submit"]:
             # Submit message
             event.stop()
             event.prevent_default()
             self.post_message(self.Submit(self.text))
             return
 
-        if event.key == "enter":
+        if event.key == self.app.tui_config["key_bindings"]["newline"]:
             if self.completion_active:
                 # Accept completion
                 self.post_message(self.CompletionAccept())
                 event.stop()
                 event.prevent_default()
                 return
             else:
+                if self.app.tui_config["key_bindings"]["newline"] != "enter":
+                    self.insert("\n")
+
+                    current_row, current_col = self.cursor_location
+                    self.cursor_location = (current_row + 1, 0)
+
                 return
 
-        if event.key == "tab":
+        if event.key == self.app.tui_config["key_bindings"]["cycle_forward"]:
             event.stop()
             event.prevent_default()
             if self.completion_active:
@@ -232,7 +248,16 @@ def on_key(self, event) -> None:
             else:
                 # Request completions
                 self.post_message(self.CompletionRequested(self.text))
-        elif event.key == "escape" and self.completion_active:
+        elif event.key == self.app.tui_config["key_bindings"]["cycle_backward"]:
+            event.stop()
+            event.prevent_default()
+            if self.completion_active:
+                # Cycle through completions
+                self.post_message(self.CompletionCyclePrevious())
+            else:
+                # Request completions
+                self.post_message(self.CompletionRequested(self.text))
+        elif event.key == self.app.tui_config["key_bindings"]["stop"] and self.completion_active:
             event.stop()
             event.prevent_default()
             self.post_message(self.CompletionDismiss())

aider/website/docs/config/tui.md

@@ -25,7 +25,7 @@ tui: true
 
 ### Complete Configuration Example
 
-Complete configuration example in YAML configuration file (`.aider.conf.yml` or `~/.aider.conf.yml`). The base theme is pretty nice but if you want different colors, do you thing:
+Complete configuration example in YAML configuration file (`.aider.conf.yml` or `~/.aider.conf.yml`). The base theme is pretty nice but if you want different colors and key bindings, do you thing:
 
 ```yaml
 tui: true
@@ -41,15 +41,53 @@ tui-config:
     error: "#ff3333"
     surface: "transparent"
     panel: "transparent"
-    dark: true
-    variables:
-      input-cursor-foreground: "#00ff87"
+    input-cursor-foreground: "#00ff87"
   other:
     dark: true
     input-cursor-text-style: "underline"
+  key_bindings:
+    newline: "enter"
+    submit: "shift+enter"
+    stop: "escape"
+    cycle_forward: "tab"
+    cycle_backward: "shift+tab"
+    focus: "ctrl+f"
+    cancel: "ctrl+c"
+    clear: "ctrl+l"
+    quit: "ctrl+q"
 
 ```
 
+### Key Command Configuration
+
+The TUI provides customizable key bindings for all major actions. The default key bindings are:
+
+| Action | Default Key | Description |
+|--------|-------------|-------------|
+| New Line | `enter` (multiline mode) / `shift+enter` (single-line mode) | Insert a new line in the input area |
+| Submit | `shift+enter` (multiline mode) / `enter` (single-line mode) | Submit the current input |
+| Cancel | `ctrl+c` | Stop and stash current input prompt |
+| Stop | `escape` | Interrupt the current LLM response or task |
+| Cycle Forward | `tab` | Cycle forward through completion suggestions |
+| Cycle Backward | `shift+tab` | Cycle backward through completion suggestions |
+| Focus | `ctrl+f` | Focus the input area |
+| Clear | `ctrl+l` | Clear the output area |
+| Quit | `ctrl+q` | Exit the TUI |
+
+#### Customizing Key Bindings
+
+You can customize any key binding by adding a `key_bindings` section to your `tui-config`. For example, to change the quit key to `ctrl+x`:
+
+```yaml
+tui-config:
+  key_bindings:
+    quit: "ctrl+x"
+```
+
+All key bindings use Textual's key syntax:
+- Single keys: `enter`, `escape`, `tab`
+- Modifier combinations: `ctrl+c`, `shift+enter`, etc.
+
 ## Benefits
 
 - **Improved Productivity**: Reduced context switching with all information visible at once