kindwolf.org Git repositories moulti / master
master

Tree @master (Download .tar.gz)

MOULTI

Moulti changes the way your shell scripts (bash, zsh, etc.) display their output in your terminal. Moulti enables you to assign the numerous lines emitted by your scripts to "steps", i.e. visual, collapsible blocks featuring their own title and color.

Here is what upgrading a Debian system looks like with Moulti:

Moulti demo: Debian upgrade (Animated PNG)

Interested? Run this demo in a container using docker or podman

Not convinced yet? What if the output of your Ansible playbooks looked like this?

Moulti: Ansible playbook output

Moulti is a tool meant for people who write and execute shell scripts and/or Ansible playbooks. Specifically, if you find yourself scrolling up your terminal to ensure everything went fine while your script is still running, then Moulti is made for you.

By the way, Moulti can also display man pages and unified diff files (with colors courtesy of delta):

Moulti: man page

Moulti: unified diff output

Installation

TL;DR: pipx install moulti; pipx ensurepath

More details in the Documentation

How?

Synopsis:

  1. Start a Moulti instance: moulti init
  2. Add a step: moulti step add step_name --title='some clever title here'
  3. Fill it: whatever_your_script_does | moulti pass step_name
  4. Repeat #2 and #3 until your script is done.

Learn how to leverage Moulti by jumping to its Documentation.

Features

As shown in the demo, Moulti enables user interactions through questions:

Moulti input question

Moulti button question

Moulti also features: - text search, similar to less: documentation - ability to maximize a single step log, similar to tmux's zoom feature - a progress bar: documentation - programmatic scrolling: documentation - an askpass helper named moulti-askpass: documentation - support for Ansible playbooks, man pages and unified diff

When it comes to look and feel, Moulti can be customised:

Implementation

Moulti is written in Python and leverages Textual, along with Pyperclip, argcomplete and unidiff.

Inspiration

Moulti remained a mere idea for a significant time (possibly years).

The idea of driving TUI elements from scripts obviously comes from tools like dialog and whiptail.

At some point, the author stumbled upon multiplex, which is probably the closest thing to Moulti. multiplex was deemed unsatisfying on multiple points (including architecture) and that prompted the development of Moulti.

procmux is also similar to Moulti but did not affect its development.

Acknowledgments

The Textual framework helped a lot, so kudos to the Textual team, and specifically to: - Will McGugan for creating it - Dave Pearson for his regular help and feedback about Textual issues


Commit History @master