add tui via trogon

.github/workflows/cog.yml

@@ -23,7 +23,7 @@ jobs:
           python-version: '3.11'
 
       - name: Install dependencies
-        run: pip install -e '.[test]'
+        run: pip install -e '.[test,tui]'
 
       - name: Run cog
         run: |

.github/workflows/test.yml

@@ -25,6 +25,9 @@ jobs:
       run: |
         pip install -e '.[test]'
         pip install 'pydantic${{ matrix.pydantic }}'
+    - name: Optionally install tui dependencies
+      run: |
+        pip install -e '.[tui]'
     - name: Run tests
       run: |
         pytest

Justfile

@@ -3,7 +3,7 @@
 
 # Install dependencies and test dependencies
 @init:
-  pipenv run pip install -e '.[test]'
+  pipenv run pip install -e '.[test, tui]'
 
 # Run pytest with supplied options
 @test *options:

docs/help.md

@@ -79,9 +79,21 @@ Commands:
   plugins       List installed plugins
   similar       Return top N similar IDs from a collection
   templates     Manage stored prompt templates
+  tui           Open Textual TUI.
   uninstall     Uninstall Python packages from the LLM environment
 ```
 
+(help-tui)=
+### llm tui --help
+```
+Usage: llm tui [OPTIONS]
+
+  Open Textual TUI.
+
+Options:
+  --help  Show this message and exit.
+```
+
 (help-prompt)=
 ### llm prompt --help
 ```

docs/usage.md

@@ -526,3 +526,23 @@ When running a prompt you can pass the full model name or any of the aliases to
 llm -m 4o \
   'As many names for cheesecakes as you can think of, with detailed descriptions'
 ```
+
+## Experimental TUI
+
+A TUI is a "text user interface" (or "terminal user interface") - a keyboard and mouse driven graphical interface running in your terminal.
+
+``llm`` has experimental support for a TUI for building command-line invocations, built on top of the [Trogon](https://github.com/Textualize/trogon) TUI library.
+
+To enable this feature you will need to install the ``trogon`` dependency. You can do that like so:
+
+```bash
+llm install trogon
+```
+
+Once installed, running the ``llm tui`` command will launch the TUI interface:
+
+```bash
+llm tui
+```
+
+You can then construct a command by selecting options from the menus, and execute it using ``Ctrl+R``.

llm/cli.py

@@ -54,6 +54,11 @@
 import warnings
 import yaml
 
+try:
+    import trogon  # type: ignore
+except ImportError:
+    trogon = None
+
 warnings.simplefilter("ignore", ResourceWarning)
 
 DEFAULT_TEMPLATE = "prompt: "
@@ -151,6 +156,10 @@ def cli():
     """
 
 
+if trogon is not None:
+    cli = trogon.tui()(cli)
+
+
 @cli.command(name="prompt")
 @click.argument("prompt", required=False)
 @click.option("-s", "--system", help="System prompt to use")

setup.py

@@ -63,7 +63,8 @@ def get_long_description():
             "types-click",
             "types-PyYAML",
             "types-setuptools",
-        ]
+        ],
+        "tui": ["trogon"],
     },
     python_requires=">=3.9",
 )