Repository files navigation

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

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

Trogon inspects your (command line) app and extracts aschema which describes the options / switches / help etc.It then uses that information to build aTextual 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.

Command line apps reward repeated use, but they lack indiscoverability.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.

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

See alsoFrogmouth, a Markdown browser for the terminal.

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.

Trogon may be installed with PyPI.

pip install trogon

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

   fromtrogonimporttui@tui()@click.group(...)defcli():    ...

3. Your click app will have a newtui command available.

1. Importfrom trogon.typer import init_tui
2. Pass your Typer CLI app into theinit_tui function, e.g.

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

3. Your Typer app will have a newtui command available.

See also theexamples folder for two example apps.

By default the command added will be calledtui and the help text for it will beOpen Textual TUI.

You can customize one or both of these using thecommand= andhelp= parameters:

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

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