trogon 0.6.0

Automatically generate a Textual TUI for your Click CLI

Trogon

Auto-generate friendly terminal user interfaces for command line apps.

🎬 Video demonstration

 

A quick tour of a Trogon app applied to sqlite-utils.

https://github.com/Textualize/trogon/assets/554369/c9e5dabb-5624-45cb-8612-f6ecfde70362

Trogon works with the popular Click library for Python, but will support other libraries and languages in the future.

How it works

Trogon inspects your (command line) app and extracts a schema which describes the options / switches / help etc. It then uses that information to build a Textual UI you can use to edit and run the command.

Ultimately we would like to formalize this schema and a protocol to extract or expose it from apps. This which would allow Trogon to build TUIs for any CLI app, regardless of how it was built. If you are familiar with Swagger, think Swagger for CLIs.

Screenshots

Why?

Command line apps reward repeated use, but they lack in discoverability. If you don't use a CLI app frequently, or there are too many options to commit to memory, a Trogon TUI interface can help you (re)discover options and switches.

What does the name mean?

This project started life as a Textual experiment, which we have been giving birds' names to. A Trogon is a beautiful bird I was lucky enough to photograph in 2017.

See also Frogmouth, a Markdown browser for the terminal.

Roadmap

Trogon is usable now. It is only 2 lines (!) of code to add to an existing project.

It is still in an early stage of development, and we have lots of improvements planned for it.

Installing

Trogon may be installed with PyPI.

pip install trogon

Quickstart

Click

1. Import from trogon import tui
2. Add the @tui decorator above your click app, e.g.

   from trogon import tui
   
   @tui()
   @click.group(...)
   def cli():
       ...
   

3. Your click app will have a new tui command available.

Typer

1. Import from trogon.typer import init_tui
2. Pass your Typer CLI app into the init_tui function, e.g.

   cli = typer.Typer(...)
   init_tui(cli)
   

3. Your Typer app will have a new tui command available.

See also the examples folder for two example apps.

Custom command name and custom help

By default the command added will be called tui and the help text for it will be Open Textual TUI.

You can customize one or both of these using the command= and help= parameters:

@tui(command="ui", help="Open terminal UI")
@click.group(...)
def cli():
    ...

Follow this project

If this app interests you, you may want to join the Textual Discord server where you can talk to Textual developers / community.