Showing GUIs from Shell Scripts

https://sixtyfps.io/blog/showing-guis-from-shell-scripts.html

by ogoffart • 5 years ago

166 55 5 years ago

einpoklum2• 5 years ago

The last thing I want in my shell script is to have it depend on a brand-new utility, which is part of the Rust ecosystem that is itself still new and evolving. Shell scripts need to be super stable and portable.

Edit: If I need GUI in my scripts, I'd probablyjust use dialog and other curses stuff.

ogoffart7• 5 years ago

Imtui is not the same things as it is a C++ library, so you don't write shell code anymore, you write C++

dialog is an option but is quite limited in what you can do. There are many alternatives, and this is just another one to choose from. Depending on where your script is required to run, a Rust tool might not be a problem. Not all shell scripts need to be super portable.

einpoklum2• 5 years ago

Yes, you're right about ImTui, removed that line. Disagree about portability. I mean, yes, you could write a shell script targeting even a single specific machine, but generally you want to assume as little as possible beyond a GNU operating system and its common utilities.

pie_flavor• 5 years ago

It's a native program; it's not going to morph out from under you. The Rust build system swears by semver compatibility, and crates.io is a permanent repository; it's not going to stop building. So what critique are you actually making, that {random C++ project} survives?

mbirth2• 5 years ago

Also most of the time I work via SSH on remote servers. I very much prefer any TUI over something I need to use X-forwarding for.

MonkeyClub• 5 years ago

I still prefer the plain question and answer approach.

The OpenBSD installer follows it, for example, and makes for a very simple interaction. When SSHing to a remote host, it's quite snappy , and has no drawing overhead.

jhgb4• 5 years ago

I mentioned the Gtk-server above. You might be able to use it across an SSH connection even without X forwarding.

tdeck• 5 years ago

I've used wish (https://linux.die.net/man/1/wish) for this in the past and it works pretty well. It used to come installed on many Linux distros but probably does not anymore.

Zenity is also an option.

tobias123452• 5 years ago

Both are wonderful options for some use cases. I would also take one of thise approaches for the simple demo in the blog post.

But the system UI that is also linked in there is something that goes beyond what you can do with e.g. zenity.

This kind of puts (almost) all the power of a modern UI description language in reach of shell scripts.

kps2• 5 years ago

And tksh (shell with tk builtins), which made (makes, if you take the trouble to install it now) it trivial to add a simple GUI to an existing shell script.

mst2• 5 years ago

Do you happen to know where there's a copy of the source? The stuff on the tcl wiki all seems to be dead and that sounds fascinating to take apart to learn how it works.

djrockstar1• 5 years ago

Related: Gooey[1] for turning python scripts into GUIs

[1] https://github.com/chriskiehl/Gooey

blamazon• 5 years ago

Gooey is amazing. You can go from a command line window to an install wizard type interface in 5 minutes.

abdusco2• 5 years ago

I usually add bottle.py[0] in my project (it's single file!) and add a simple HTML form with a submit button. When I need to show a UI, I start a server, open up the URL and when the form is submitted, I shutdown the server and continue executing the script.

Using HTML means I can start off with plain HTML and no style (except user-agent) and keep building on it (change font, center it in the page, etc.). I can keep HTML, JS, CSS on the same page, add AlpineJS[1] if I need a reactive UI and so on.

The only thing missing is that I can't close the tab using JavaScript when it's finished, so the user (usually me) has to close it himself.

[0] https://bottlepy.org/docs/dev/

[1] https://alpinejs.dev

y4mi• 5 years ago

The only thing missing is that I can't close the tab using JavaScript when it's finished, so the user (usually me) has to close it himself.

how come? doesn't window.close() work for you?

    save(event) {
      ...take the action you wanted...
      window.close()
    }
    <button onclick="(event) => save(event)">

abdusco2• 5 years ago

That only works for popup windows (ones created with `window.open()`) [0].

From MDN:

This method can only be called on windows that were opened by a script using the Window.open() method.

I was unable to get `window.close()` to work on root windows, but your comment prompted me research it again. This seems to work:

    window.close('','_parent','')

[0]: https://developer.mozilla.org/en-US/docs/Web/API/Window/clos...

29athrowaway• 5 years ago

What about dialog, zenity, kdialog?

ogoffart7• 5 years ago

That works for simple text input stuff, but not when you want a more complex or custom GUI like the second example.

mbirth2• 5 years ago

If you need a complex GUI, I guess it's time to ditch the shell script and reimplement it in a higher language...

augustk• 5 years ago

For simple dialog boxes, Zenity is also an option:

https://help.gnome.org/users/zenity/stable/

beardyw• 5 years ago

I used zenity but found yad, mentioned elsewhere, to be AFAICT zenity compatible but with more features.

jandrese• 5 years ago

The big advantage of Zenity is that is it installed by default. A lot of other systems have fantastic usability and better options, but they aren't installed on the machine so it's moot.

maddyboo• 5 years ago

I like yad[0] for this. For example, I use it to present a GUI color picker to change/insert colors in Vim (via a plugin called vCoolor[1]). I also use it in some i3/sway scripts that need user input or to show a progress bar.

[0] https://github.com/v1cont/yad

[1] https://github.com/KabbAmine/vCoolor.vim

ogoffart7• 5 years ago

YAD is, in fact, the source of inspiration for this blog post. I seen YAD mentioning and that you can do pretty advanced stuff with it. Since we're developing a GUI framework I thought we could do the same with our viewer utility, and be even more flexible.

amelius• 5 years ago

Tcl/Tk reinvented?

mhd• 5 years ago

Or Motif's UIL, as if people cried out for that.

pjmlp3• 5 years ago

I have been seeing lots of reinventations lately, I guess learning about computer history is not really a thing.

tronical2• 5 years ago

One of the lesson that I believe is being learned is that general purpose programming languages for UIs make it difficult to do tooling, especially with dynamic typing.

This particular approach (.60) is not a general purpose programming language and it's strongly typed.

It's designed for the user interface, not for writing the rest of the program in it.

I feel this is rather different from the tcl/tk applications we used to see?

louissan• 5 years ago

it tickles

bjarneh• 5 years ago

error: failed to run custom build command for `servo-fontconfig-sys v5.1.0`

Not sure users who prefer a GUI over the command line, would be too happy about having to fix compile errors prior to running the program?

tobias123452• 5 years ago

Yes, there should be pre-build binaries of the viewer available.

Right now there is not, but work is being done to cover the common platforms.

ageofwant• 5 years ago

No Python bindings, in 2021 ? That's pretty balsy.

ogoffart7• 5 years ago

We plan to add bindings to more languages such as Python, Go, and others

dschulz• 5 years ago

Very cool project! It's exciting to see two reputable Qt & KDE devs doing fresh stuff. (as a long-time linux user and Qt and KDE hobbyist I recognize their names like a sports fan recognizes their favorite players' names)

ogoffart7• 5 years ago

thank you :-)

dijit• 5 years ago

cargo install sixtyfps-viewer

I don't believe Cargo install is meant to be used as a general purpose distribution tool; though I know it's tempting to bypass the package manager especially when it's so easy.

From what I understand cargo install is supposed to help around rust ecosystem tooling such as installing clippy, xargo and rls, where cargo has much more context than the package manager.

From the RFC the motivations for `cargo install` existing:

Simple tasks like installing a new cargo subcommand, installing an editor plugin, etc,

https://rust-lang.github.io/rfcs/1200-cargo-install.html

tronical2• 5 years ago

Short of building distribution packages and offering those as binaries for the download, this seems like a simple way to offer a download.

It's not perfect though, and I think we're going to try to create binaries for download alternatively.

ehutch793• 5 years ago

That's exactly what distribution package managers are meant for.

jhgb4• 5 years ago

Obligatory mention of Gtk-Server: https://www.gtk-server.org

Can communicate using nine IPC mechanisms AND as a loadable library with a small C API.

Also, if you're running a Gtk desktop, it obviously obeys your Gtk theme.

ehutch793• 5 years ago

If you're adding IPC mechanisms to a shell script, seriously consider if you should be writing it in a lower level language, like python or go or rust...

jhgb4• 5 years ago

You can use it from whatever you want; it's not just for shell scripts.

Although why you'd go for a lower level language if you don't have to for some specific reason is beyond me. GUIs specifically have been historically very friendly towards very high level languages - see Tcl/Tk.

Also, by your logic, shell scripts should never use pipes; you should always use pipes from Python or Go or Rust. But I suspect that's not how other people usually think.

chasil• 5 years ago

The original graphical shell was written by J. Stephen Pendergrast and documented in the book "Desktop KornShell Graphical Programming," ISBN 0-201-63375-2. This book is hard to find.

Pendergrast's shell was included in the CDE standard, directly accesses Motif and X11 primitives, and builds on modern systems.

The source code is in this collection:

https://sourceforge.net/projects/cdesktopenv/

mark_and_sweep2• 5 years ago

On Windows, I use the built-in Microsoft HTML Applications (HTAs) to build single-file, double-clickable GUIs in JS. Using ActiveXObject from within your HTA, you can write scripts for pretty much anything on your PC. (So this isn't showing a GUI from a script, but scripting from within a GUI application).

ducharmdev• 5 years ago

Wow, that's kinda magical. I had no idea that was a thing!

mark_and_sweep2• 5 years ago

I've started writing a guide about it: https://marksweb.site/hta/ It's still very much work in progress, but maybe it helps if you wanna try developing HTAs.

woodrowbarlow• 5 years ago

it seems like it would be more straightforward to build a gui that invokes your shell scripts, rather than modify your shell scripts to include a gui.

Showing GUIs from Shell Scripts

Related Stories