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 how upgrading a Debian system looks like with Moulti:
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 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):
Installation
TL;DR: pipx install moulti; pipx ensurepath
More details in the Documentation
How?
Synopsis:
- Start a Moulti instance:
moulti init
- Add a step:
moulti step add step_name --title='some clever title here'
- Fill it:
whatever_your_script_does | moulti pass step_name
- 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 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:
- through
moulti set
: define whether Moulti steps flow up or down: documentation - through Textual CSS (TCSS): documentation
- through ANSI themes: documentation
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
- network_loop: unlink socket if necessary. Xavier G. 7 months ago
- protocol: make the default socket user-specific. Xavier G. 7 months ago
- exec: ensure MOULTI_SOCKET_PATH is set. Xavier G. 7 months ago
- cli: fix help strings. Xavier G. 7 months ago
- setup.py: add missing module moulti.widgets. Xavier G. 7 months ago
- protocol: catch ConnectionResetError. Xavier G. 7 months ago
- Harmonise logdebug() format. Xavier G. 7 months ago
- Make read() and accept() more robust. Xavier G. 7 months ago
- logdebug(): fix worker/thread detection. Xavier G. 7 months ago
- MoultiLog: adjust scrolling behavior. Xavier G. 7 months ago
- Introduce the MoultiLog widget. Xavier G. 7 months ago
- Step: fix issue with colors spanning multiple lines. Xavier G. 7 months ago
- pass: change default read size. Xavier G. 7 months ago
- Allow end users to set their own (optional) CSS file. Xavier G. 7 months ago
- Fix various details reported by pylint. Xavier G. 7 months ago
- Configure mypy. Xavier G. 7 months ago
- Reorder import statements. Xavier G. 7 months ago
- app: rename debug() to logdebug(). Xavier G. 7 months ago
- Use type checking across all the Moulti codebase. Xavier G. 7 months ago
- step_from_message(): adjust query. Xavier G. 7 months ago
- MoultiMessageException: fix missing base class. Xavier G. 7 months ago
- VertScroll: simplify watch_show_vertical_scrollbar(). Xavier G. 7 months ago
- Fix various details reported by ruff. Xavier G. 7 months ago
- Configure ruff. Xavier G. 7 months ago
- init_debug(): fix invalid widget id. Xavier G. 7 months ago
- Step: style CollapsibleTitle (i.e. the title line). Xavier G. 7 months ago
- append_from_queue_to_step(): improve buffering. Xavier G. 7 months ago
- Add moulti run. Xavier G. 7 months ago
- accept(): add security checks. Xavier G. 7 months ago
- getaddr(): getpeername() may return '' for unbound sockets. Xavier G. 7 months ago