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
- moulti pass: significant performance improvement. Xavier G. 4 months ago
- Step: add control over inner auto-scrolling. Xavier G. 4 months ago
- MoultiLog: remove obsolete workaround. Xavier G. 4 months ago
- Tag v1.15.0. Xavier G. 4 months ago
- Ansible callback plugin: introduce MOULTI_ANSIBLE_COLLAPSE. Xavier G. 4 months ago
- Footer: the `Lock scroll` keybinding now displays "Unlock scroll". Xavier G. 4 months ago
- programmatic scrolling: remove obsolete workaround. Xavier G. 4 months ago
- Remove obsolete statements. Xavier G. 4 months ago
- AbstractStep: checking Rich markup early is no longer required Xavier G. 4 months ago
- Footer: the `Dark/Light` keybinding now displays either "Dark" or "Light". Xavier G. 4 months ago
- buttonquestion: improve handling of invalid styles. Xavier G. 4 months ago
- Introduce MoultiWidget*Exception classes. Xavier G. 4 months ago
- Collapse/expand both existing and new steps. Xavier G. 4 months ago
- Force-collapse/expand new steps. Xavier G. 4 months ago
- Add keyboard shortcuts to navigate unanswered questions. Xavier G. 4 months ago
- setup.py: explicitly require Python >= 3.10. Xavier G. 4 months ago
- Tag v1.14.0. Xavier G. 4 months ago
- Quit dialog: add keyboard accelerators. Xavier G. 4 months ago
- Quit dialog: react to Ctrl+c. Xavier G. 4 months ago
- moulti run: fix issue at exit time. Xavier G. 4 months ago
- Step: read input in a non-blocking fashion. Xavier G. 4 months ago
- Ansible callback plugin: support `prompt_until()` and the `pause` module. Xavier G. 4 months ago
- cli: --help: remove capitals and full stops. Xavier G. 4 months ago
- Introduce questions. Xavier G. 4 months ago
- Tag v1.13.0. Xavier G. 5 months ago
- Ansible callback plugin: handle `vars_prompt` using inputquestion widgets. Xavier G. 5 months ago
- Ansible callback plugin: do not try to pass text to a divider. Xavier G. 5 months ago
- QuitDialog: make it more keyboard-friendly. Xavier G. 5 months ago
- protocol: fix useless return. Xavier G. 5 months ago
- Ensure only one instance of the quit dialog is shown at any time. Xavier G. 5 months ago