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
- programmatic scrolling: update documentation. Xavier G. 8 months ago
- programmatic scrolling: add scroll-on-activity. Xavier G. 8 months ago
- programmatic scrolling: add "Scroll lock" action. Xavier G. 8 months ago
- programmatic scrolling: add moulti scroll. Xavier G. 8 months ago
- programmatic scrolling: add StepContainer.scroll_to_step(). Xavier G. 8 months ago
- Add moulti --step-direction. Xavier G. 8 months ago
- The "Save" feature now exports the progress bar. Xavier G. 8 months ago
- Add moulti set --step-position. Xavier G. 8 months ago
- Bash functions: run only moulti_delayed_collapse in the background. Xavier G. 8 months ago
- Add OCI image moulti-demo. Xavier G. 8 months ago
- Tag v1.5.1. Xavier G. 8 months ago
- Documentation: improve section "Moulti does not" Xavier G. 8 months ago
- protocol: fix pipelining issue. Xavier G. 8 months ago
- Tag v1.5.0. Xavier G. 9 months ago
- Update Changelog. Xavier G. 9 months ago
- app: fix handling of MOULTI_CUSTOM_CSS. Xavier G. 9 months ago
- buttonquestion: improve application of new button layouts. Xavier G. 9 months ago
- app: ensure "textual run --dev moulti.app" works out of the box. Xavier G. 9 months ago
- buttonquestion: introduce a better layout. Xavier G. 9 months ago
- app: fix mypy error. Xavier G. 9 months ago
- Documentation: explain how to use the progress bar. Xavier G. 9 months ago
- cli: add arguments related to the progress bar. Xavier G. 9 months ago
- app: handle messages related to the progress bar. Xavier G. 9 months ago
- app: add a hidden progress bar. Xavier G. 9 months ago
- app: handle_message may now schedule multiple calls. Xavier G. 9 months ago
- console: minor improvements. Xavier G. 9 months ago
- Update Changelog. Xavier G. 9 months ago
- Add tooltips. Xavier G. 9 months ago
- AbstractStep: on_click(): minor improvements. Xavier G. 9 months ago
- Bash functions: compute and display step duration. Xavier G. 9 months ago