remote/sqlite-utils
1
0
Fork 0
mirror of https://github.com/simonw/sqlite-utils.git synced 2026-07-26 19:04:32 +02:00
Code Issues Projects Releases Packages Wiki Activity

Documentation for trogon TUI, refs #545

Browse source
This commit is contained in:
Simon Willison 2023-05-21 10:53:22 -07:00
commit b1a2bb1dbf
5 changed files with 43 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

22
docs/cli.rst
View file

@ -2159,3 +2159,25 @@ You can uninstall packages that were installed using ``sqlite-utils install`` wi
$ sqlite-utils uninstall beautifulsoup4
Use ``-y`` to skip the request for confirmation.
.. _cli_tui:
Experimental TUI
================
A TUI is a "text user interface" (or "terminal user interface") - a keyboard and mouse driven graphical interface running in your terminal.
``sqlite-utils`` has experimental support for a TUI for building command-line invocations, built on top of the `Trogan <https://github.com/Textualize/trogon/>`__ TUI library.
To enable this feature you will need to install the ``trogan`` dependency. You can do that like so::
sqite-utils install trogan
Once installed, running the ``sqlite-utils tui`` command will launch the TUI interface::
sqlite-utils tui
You can then construct a command by selecting options from the menus, and execute it using ``Ctrl+R``.
.. image:: _static/img/tui.png
:alt: A TUI interface for sqlite-utils - the left column shows a list of commands, while the right panel has a form for constructing arguments to the add-column command.