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
- Documentation: describe how to save and restore a Moulti instance. Xavier G. 6 months ago
- app: fix exported file mode. Xavier G. 6 months ago
- gitignore: add vim files. Xavier G. 6 months ago
- Add "Save" action. Xavier G. 6 months ago
- MoultiLog: introduce to_file() method. Xavier G. 6 months ago
- Introduce export_properties() methods. Xavier G. 6 months ago
- MoutiWidgets: add method class_to_command(). Xavier G. 6 months ago
- Documentation: add "moulti run: dealing with stdin, stdout, stderr" Xavier G. 6 months ago
- QuitDialog: allow users to terminate the process launched by "moulti run". Xavier G. 6 months ago
- Documentation: minor improvements. Xavier G. 6 months ago
- Use double-dash (--) in all "moulti run" commands. Xavier G. 6 months ago
- app: fix obsolete comment. Xavier G. 6 months ago
- Introduce a modal dialog shown when quitting Moulti. Xavier G. 6 months ago
- app: add an attribute to track the init command state. Xavier G. 6 months ago
- app: "moulti run" now sets MOULTI_INSTANCE_PID. Xavier G. 6 months ago
- Documentation: improve the "Environment variables" section. Xavier G. 6 months ago
- cli: add --version command-line argument. Xavier G. 6 months ago
- Tag v1.2.0. Xavier G. 7 months ago
- README: mention questions. Xavier G. 7 months ago
- Documentation: add "Interact with end users through questions" Xavier G. 7 months ago
- Move "step_" prefix to the AbstractStep class. Xavier G. 7 months ago
- app: ensure widget id and type match. Xavier G. 7 months ago
- Examples: upgrade-system.bash: adjust collapse behavior. Xavier G. 7 months ago
- Examples: upgrade-system.bash now showcases buttonquestion. Xavier G. 7 months ago
- Move "moulti pass" implementation from app to step. Xavier G. 7 months ago
- setup.py: add inputquestion package. Xavier G. 7 months ago
- Introduce input questions. Xavier G. 7 months ago
- buttonquestion: remove unused import. Xavier G. 7 months ago
- Introduce button questions. Xavier G. 7 months ago
- Refactoring: allow for widgets other than steps. Xavier G. 7 months ago