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:
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
- ChangeLog: fix 1.24.0/Changed title. Xavier G. 6 days ago
- Tag v1.24.0. Xavier G. 6 days ago
- Switch to Textual 0.86. Xavier G. 6 days ago
- Tag v1.23.2. Xavier G. 9 days ago
- pylint: work around a Python 3.13.1-specific bug. Xavier G. 9 days ago
- Github: introduce CI for NetBSD. Xavier G. 9 days ago
- Github: introduce CI for OpenBSD. Xavier G. 9 days ago
- Tests: test_scrolling: reduce the odds of a race condition. Xavier G. 9 days ago
- Tests: test_quit: leverage the Beacon class. Xavier G. 9 days ago
- Tests: introduce the Beacon class. Xavier G. 9 days ago
- Github: disable fail-fast for Ubuntu+macOS checks. Xavier G. 9 days ago
- Github: introduce CI for FreeBSD. Xavier G. 9 days ago
- Github: expand tests to more operating systems. Xavier G. 9 days ago
- Tests: shell scripts: improve portability. Xavier G. 9 days ago
- pylint, mypy: fix warnings re: OS-specific import. Xavier G. 9 days ago
- Leverage Github Actions. Xavier G. 9 days ago
- Introduce snapshot-based tests. Xavier G. 9 days ago
- App, Step: close file objects/descriptors/selectors. Xavier G. 9 days ago
- helpers: add clean_selector(). Xavier G. a month ago
- Tag v1.23.1. Xavier G. a month ago
- pylint: fix warnings after upgrade to pylint 3.3.1. Xavier G. a month ago
- Documentation: first steps: showcase the "inactive" class. Xavier G. a month ago
- Ansible callback plugin: fix `unexpected keyword argument 'caplevel'` warning. Xavier G. a month ago
- App: better reflect whether the init command is running. Xavier G. a month ago
- App: constructor: add instance_name parameter. Xavier G. a month ago
- App: fix pylint redefined-outer-name warning. Xavier G. a month ago
- App: improve network error handling. Xavier G. a month ago
- Tag v1.23.0. Xavier G. a month ago
- Focus indicators: fix rendering issue induced by Textual 0.84.0. Xavier G. a month ago
- CollapsibleStep: do not scroll when expanding. Xavier G. a month ago