Moulti

https://github.com/xavierog/moulti
Admin
Moulti is a terminal UI tool that organizes and enhances the output of shell scripts and Ansible...
Tokens:14,547
Snippets:148
Trust Score:7.5
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Moulti Installation and Usage Synopsis

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/index.md

This snippet outlines the basic installation and usage workflow for Moulti. It shows how to initialize Moulti, add a new step with a title, and pass script output to that step. The commands are intended for shell environments.

```bash
pipx install moulti; pipx ensurepath
moulti init
moulti step add step_name --title='some clever title here'
whatever_your_script_does | moulti pass step_name
```

--------------------------------

### Install Moulti using pipx

Source: https://github.com/xavierog/moulti/blob/master/README.md

This command installs the Moulti tool globally using pipx, a tool for installing and running Python applications in isolated environments. Ensure pipx is installed and in your PATH.

```bash
pipx install moulti; pipx ensurepath
```

--------------------------------

### Moulti Configuration Example

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/index.md

This example demonstrates how to configure Moulti settings using the `moulti set` command. It specifically shows how to define the direction in which Moulti steps flow, either up or down.

```bash
moulti set direction-and-position
```

--------------------------------

### Asciinema Player Setup for Moulti Demo

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/index.md

This Javascript code demonstrates how to initialize and play an Asciinema recording for the Moulti Debian upgrade demo. It includes error handling for cases where the Asciinema Player library might not be immediately available, deferring the setup until the page loads.

```javascript
function setup_demo() {
	AsciinemaPlayer.create(
		'assets/asciicasts/demo-debian-upgrade.cast',
		document.getElementById('asciicast-demo-debian-upgrade'),
		{
			autoPlay: false,
			cols: 128,
			loop: true,
			poster: 'npt:6',
			rows: 42,
		}
	);
}
try {
	player = AsciinemaPlayer; /* may throw ReferenceError */
	setup_demo();
} catch (ReferenceError) {
	/* The Asciinema JS file has not loaded yet: defer setup until after the page has loaded: */
	addEventListener('load', (event) => { setup_demo(); });
}
```

--------------------------------

### Install Moulti using pipx

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/install.md

Installs the Moulti Python package using pipx, a tool for installing and running Python applications in isolated environments. It also ensures the 'moulti' command is available in the system's PATH.

```shell
pipx install moulti
pipx ensurepath
```

--------------------------------

### Moulti Instance Environment Variables Example

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/environment-variables.md

Example output of environment variables set by a Moulti instance when executing a command, including MOULTI_RUN, MOULTI_SOCKET_PATH, MOULTI_INSTANCE_PID, and SSH related variables.

```console
MOULTI_RUN=moulti
MOULTI_SOCKET_PATH=@moulti-username-default.socket
MOULTI_INSTANCE_PID=271828
SSH_ASKPASS=moulti-askpass
SSH_ASKPASS_REQUIRE=force
SUDO_ASKPASS=/usr/local/bin/moulti-askpass
```

--------------------------------

### Interactive Moulti Pass Usage Example (Console)

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/steps.md

Demonstrates the interactive use of 'moulti pass' where lines are entered one by one and the session is terminated with Ctrl+d. This shows the expected input flow for interactive use.

```console
$ moulti pass my_step
1st line<enter>
2nd line<enter>
n-th line<enter>
last line<enter>
<Ctrl+d>
```

--------------------------------

### Launch Moulti TUI

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/first-steps.md

Initializes and launches the Moulti Terminal User Interface (TUI). This command starts the main Moulti application in the current terminal.

```shell
moulti init
```

--------------------------------

### Asciinema Player Setup for Moulti Type Demo

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/moulti-functions.md

JavaScript code to initialize and control an Asciinema player for the 'moulti_type' demo. It handles autoplay, looping, and deferred setup if the Asciinema library is not immediately available.

```javascript
function setup_demo_moulti_type() {
	const player = AsciinemaPlayer.create(
		'../assets/asciicasts/demo-moulti-type.cast',
		document.getElementById('asciicast-demo-moulti-type'),
		{ autoPlay: true, cols: 100, controls: false, preload: true, rows: 5, }
	);
	/* Prevent a visual glitch by looping between the first marker ("ready") and the end: */
	player.addEventListener('ended', () => {
		player.seek({ marker: 0 }).then(() => { player.play(); });
	});
}
try {
	asc_player = AsciinemaPlayer; /* may throw ReferenceError */
	setup_demo_moulti_type();
} catch (ReferenceError) {
	/* The Asciinema JS file has not loaded yet: defer setup until after the page has loaded: */
	addEventListener('load', (event) => { setup_demo_moulti_type(); });
}
```

--------------------------------

### Create and fill a Moulti step with file content in Python

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/python-scripting.md

This example shows how to create a new step and populate it with the content of a file using a single connection to Moulti. It utilizes `moulti_connect`, `send_json_message`, and `recv_json_message` for managing the interaction.

```python
from moulti.client import moulti_connect, recv_json_message, send_json_message

filepath = '/etc/passwd'
with moulti_connect() as moulti_socket:
	# Create a new step:
	# moulti step add python --title="${filepath}:" --no-collapsed
    add_step_msg = {
		'command': 'step', 'action': 'add', 'id': 'python',
		'title': f'{filepath}:', 'collapsed': False,
	}
    send_json_message(moulti_socket, add_step_msg)
    recv_json_message(moulti_socket)

	# Fill that new step with the contents of a regular file: 
    with open(filepath) as filedesc:
		# moulti pass python < /etc/passwd
        pass_fd_msg = {'command': 'pass', 'id': 'python'}
        send_json_message(moulti_socket, pass_fd_msg, [filedesc.fileno()])
        recv_json_message(moulti_socket)
```

--------------------------------

### List Saved Moulti Instance Files (Console)

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/saving-and-loading.md

This example demonstrates the file structure created when saving a complete Moulti instance. It includes JSON files for instance properties and step properties, as well as log files for step contents.

```console
$ ls -al social-preview-2024-02-23T18-52-10.883600/
-rw-r--r-- 1 user group   61 2024-02-23 18:52:10 0-instance.properties.json
-rw-r--r-- 1 user group 1.8K 2024-02-23 18:52:10 1-title.contents.log
-rw-r--r-- 1 user group  394 2024-02-23 18:52:10 1-title.properties.json
-rw-r--r-- 1 user group  554 2024-02-23 18:52:10 2-step_ping.contents.log
-rw-r--r-- 1 user group  376 2024-02-23 18:52:10 2-step_ping.properties.json
-rw-r--r-- 1 user group   34 2024-02-23 18:52:10 3-collapsed.contents.log
-rw-r--r-- 1 user group  310 2024-02-23 18:52:10 3-collapsed.properties.json
-rw-r--r-- 1 user group 9.3K 2024-02-23 18:52:10 4-script.contents.log
-rw-r--r-- 1 user group  273 2024-02-23 18:52:10 4-script.properties.json
-rw-r--r-- 1 user group  567 2024-02-23 18:52:10 5-poll.properties.json
```

--------------------------------

### Run Command to Drive Moulti TUI with moulti run

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/subcommands.md

The `moulti run` command starts a Moulti TUI instance and executes a command designed to control it. The 'Shell scripting: moulti run' guide offers further details.

```bash
moulti run
```

--------------------------------

### Restore Moulti Instance (Shell)

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/saving-and-loading.md

This command shows the standard procedure for restoring a previously saved Moulti instance. It involves starting a new Moulti instance and instructing it to load the contents from a specified directory.

```shell
moulti run moulti load social-preview-2024-02-23T18-52-10.883600/
```

--------------------------------

### Running SSH Command via Moulti

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/shell-scripting.md

Provides an example of executing an SSH command through `moulti run`, which automatically configures `moulti-askpass` for handling SSH authentication prompts.

```bash
moulti run ssh -q -p 2220 bandit0@bandit.labs.overthewire.org head -17 /etc/motd
```

--------------------------------

### View Latest Git Commit Diff with Moulti

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/diff.md

Leverages `moulti run` and `moulti diff run` to display the diff of the latest Git commit in a specified directory. This requires Git to be installed and the path to be valid.

```shell
moulti run -- moulti diff run -- git -C /path/to/git/working/directory show
```

--------------------------------

### Get InputQuestion answer in Moulti

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/questions.md

Retrieves the answer submitted by the user for a previously created InputQuestion. The `--wait` flag ensures the command blocks until an answer is provided.

```console
$ moulti inputquestion get-answer my_first_question --wait
Alice
$
```

--------------------------------

### Pipe Diff Data to Moulti (CLI)

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/diff.md

Reads diff data from standard input via a pipe, allowing integration with other commands like `diff`. This example shows piping diff output to Moulti for parsing.

```shell
diff -u /etc/passwd /etc/passwd- | moulti diff parse /dev/stdin
```

--------------------------------

### Example of Script Output with Separators

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/index.md

This console output exemplifies a common pattern in shell scripting where ASCII characters are used to visually separate different parts of a script's output. This is the pattern that Moulti aims to improve upon by providing a more interactive TUI experience.

```console
$ my-huge-batch.sh
======== PART 1 ========
[10,000 lines of output]
======== PART 2 ========
[10,000 lines of output]
======== PART 3 ========
[10,000 lines of output]
Huge batch finished, exiting with return code 0.
```

--------------------------------

### Get ButtonQuestion answer in Moulti

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/questions.md

Retrieves the value associated with the button the user selected for a ButtonQuestion. The `--wait` flag makes the command wait for user interaction.

```console
$ moulti buttonquestion get-answer my_second_question --wait
craig
$
```

--------------------------------

### Applying Custom TCSS Styles in Moulti

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/classes.md

This example demonstrates how to enable custom TCSS styles in Moulti by setting the MOULTI_CUSTOM_CSS environment variable to the path of the custom CSS file, initializing Moulti, and then applying a custom class to a step.

```shell
export MOULTI_CUSTOM_CSS=/absolute/path/to/moulti-custom.tcss
moulti init
moulti step add test_step --classes=customstate --bottom-text=' '
moulti-askpass
```

--------------------------------

### Get Question answer in Moulti

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/questions.md

Retrieves the answer from a combined Question widget, which can be either the input field's value or the value of a selected button. The `--wait` option ensures the command waits for the user's input.

```console
$ moulti question get-answer my_third_question --wait
My name is Luka
$
```

--------------------------------

### Get current ISO date and time with moulti_iso_date

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/moulti-functions.md

Outputs the current date, time, and timezone with millisecond precision in ISO 8601 format. It attempts to use various system commands and libraries for accurate timestamp generation.

```bash
source moulti-functions.bash
moulti_iso_date
```

--------------------------------

### Basic Moulti Workflow

Source: https://github.com/xavierog/moulti/blob/master/README.md

This sequence demonstrates the fundamental steps to use Moulti: initializing a session, adding a new step with a title, and piping script output to that step. This process allows for structured output in the terminal.

```bash
moulti init
moulti step add step_name --title='some clever title here'
whatever_your_script_does | moulti pass step_name
```

--------------------------------

### Filling Moulti Steps with Commands

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/steps.md

Demonstrates different command-line methods to populate Moulti steps with text. 'moulti pass' is recommended for unlimited text, while 'add' and 'update' are suitable for immediate or existing steps. 'append' can be used to add lines incrementally.

```bash
moulti pass my_step
```

```bash
moulti step add my_step --text=$'line1\nline2\nline3'
```

```bash
moulti step update my_step --text=$'line1\nline2\nline3'
```

```bash
moulti step append my_step 'line1' 'line2' 'line3'
```

--------------------------------

### Using moulti-man wrapper

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/manpage.md

Demonstrates how to use the `moulti-man` wrapper to read man pages for specific commands or system calls. This is a convenient way to access manual pages through Moulti.

```shell
# Read the man page for the bash shell:
moulti-man bash
# Read the man page for the open() syscall:
moulti-man 2 open
```

--------------------------------

### Initializing Moulti Askpass

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/shell-scripting.md

Shows how to initialize a Moulti instance specifically for testing the `moulti-askpass` utility in a TUI environment.

```bash
MOULTI_INSTANCE=trying-moulti-askpass moulti init
```

--------------------------------

### Using pty for Moulti Input

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/steps.md

Illustrates how to use the 'script' command with pty allocation to capture and pipe output to Moulti, which can help manage output buffering and display colors/emojis.

```bash
script --quiet --return --command 'your command here' /dev/null | moulti pass your_step
```

--------------------------------

### Apply Rich Markup to Moulti Step

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/first-steps.md

Demonstrates the use of Rich markup for styling text within a Moulti step's bottom text. It showcases various styles and colors available through the Rich library.

```shell
moulti step update my_step --bottom-text \
    '[blink]blink[/] [bold]bold[/] [conceal]conceal[/] [italic]italic[/] [overline]overline[/] [reverse]reverse[/] [strike]strike[/] [underline]underline[/] [underline2]underline2[/] [blue]blue[/] [on yellow1]on yellow1[/] [blue on yellow1]blue on yellow1[/]'
```

--------------------------------

### Set Terminal for Moulti

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/first-steps.md

Configures the terminal environment to support 24-bit colors, which is recommended for optimal visual display in Moulti. This involves setting the TERM and COLORTERM environment variables.

```shell
export TERM=xterm-256color
COLORTERM=truecolor
```

--------------------------------

### Add Multiple Moulti Steps with Different Classes

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/first-steps.md

Adds multiple Moulti steps in a loop, each assigned a different class ('warning', 'error', 'inactive', 'standard') to showcase distinct styling. It also sets titles and simple text content for each step.

```shell
for class in warning error inactive standard; do
    moulti step add "${class}_example" \
        --classes="${class}" \
        --title="${class^} step" \
        --text="This is a step with class '${class}'." \
        --bottom-text=' ';
done
```

--------------------------------

### Using Moulti Askpass for User Input

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/shell-scripting.md

Demonstrates various ways to use the `moulti-askpass` command-line tool to prompt users for input, including setting default prompts and handling specific prompt types.

```bash
export MOULTI_INSTANCE=trying-moulti-askpass
moulti-askpass 'Tell me a secret:'
MOULTI_ASKPASS_DEFAULT_PROMPT='Tell me another secret' moulti-askpass
SSH_ASKPASS_PROMPT=confirm moulti-askpass 'If you can read this, then moulti-askpass works fine'
SSH_ASKPASS_PROMPT=none moulti-askpass 'If you can read this, then moulti-askpass works fine'
```

--------------------------------

### Clear a Moulti Step

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/first-steps.md

Clears the content of a specific Moulti step ('warning_example'), effectively emptying its log and text fields without removing the step itself.

```shell
moulti step clear warning_example
```

--------------------------------

### Record Debian Upgrade Demo with Podman

Source: https://github.com/xavierog/moulti/blob/master/doc/assets/asciicast/HOWTO.md

This command records an asciinema session demonstrating a Debian upgrade process within a podman container. It sets the title, terminal dimensions, and executes the podman run command.

```shell
asciinema rec --title='Moulti demo: Debian upgrade' --cols=128 --rows=42 -c 'podman run -it moulti-demo' demo-debian-upgrade.cast
```

--------------------------------

### Pass Command Output to Moulti Step

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/first-steps.md

Pipes the output of a command (e.g., 'ip -c a') to a specific Moulti step ('my_step'). This populates the log part of the step with the command's output.

```shell
ip -c a | moulti pass my_step
```

--------------------------------

### Add a Moulti Step

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/first-steps.md

Adds a new step to the Moulti instance with a specified ID and title. This is a fundamental operation for organizing content within Moulti.

```shell
moulti step add my_step --title='My first step'
```

--------------------------------

### Bash Wrapper for Existing Scripts with Moulti

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/existing-scripts.md

This bash script acts as a wrapper for an external command-line tool. It initializes a Moulti instance, sets a title for the execution, and pipes the tool's output to Moulti's line processing functions to create steps dynamically. It requires the 'moulti-functions.bash' script.

```bash
#!/usr/bin/env bash

# If not done already, start a Moulti instance and have it re-execute this script:
export MOULTI_INSTANCE="moulti-first-lines"
[ "${MOULTI_RUN}" ] || exec moulti run -- "$0" "$@"

source moulti-functions.bash
# custom parsing goes here

# Instance title:
moulti set --title="First lines: $@"

# Run "first-lines" and pipe its output to moulti_process_lines():
first-lines "$@" 2>&1 | moulti_process_lines

```

--------------------------------

### Underlying moulti run command for man pages

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/manpage.md

Illustrates the underlying command executed by `moulti-man`. It shows how `moulti run` is used to process the output of the `man` command and convert it into Moulti widgets.

```shell
moulti run -- moulti manpage run -- man bash
```

--------------------------------

### Set Moulti Instance Title

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/first-steps.md

Sets a custom title for the Moulti instance using the CLI client. This change is immediately reflected in the TUI.

```shell
moulti set --title='This is MY (first) Moulti instance'
```

--------------------------------

### Add a Question with input and buttons in Moulti

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/questions.md

Creates a Question widget that combines both an input field and buttons. The `{input}` placeholder allows dynamic button labels based on the input field's content.

```shell
moulti question add my_third_question \
    --title='My third question with Moulti' \
    --text='What is your name?' \
    --bottom-text='I live on the second floor' \
    --placeholder='Enter your name in this input field, or click a button' \
    --button 'My name is Alice' default Alice \
    --button 'My name is Bob' default Bob \
    --button 'My name is {input}' success 'Neither, use input'
```

--------------------------------

### Create and update a Moulti step from Python

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/python-scripting.md

This snippet demonstrates creating a new step and then updating its content using the `send_to_moulti` function from the `moulti.client` module. It involves two separate connections to the Moulti instance.

```python
from moulti.client import send_to_moulti

# Create a new step:
# moulti step add python --title="Step created from Python" --no-collapsed
add_step_msg = {
	'command': 'step', 'action': 'add', 'id': 'python',
	'title': 'Step created from Python', 'collapsed': False,
}
send_to_moulti(add_step_msg)

# Generate text and update the step:
text = '\n'.join(['Python made this: ' + chr(i)*62 for i in range(33, 127)])
# moulti step update python --text="${text}"
set_text_msg = {
	'command': 'step', 'action': 'update', 'id': 'python',
	'text': text,
}
send_to_moulti(set_text_msg)
```

--------------------------------

### Update Moulti Step with Classes and Text

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/first-steps.md

Updates an existing Moulti step by applying CSS classes (like 'success') and adding top text. The 'success' class typically styles the step to indicate a successful operation.

```shell
# Applying the "success" class turns the step green:
moulti step update my_step --classes='success'
# Steps have optional top and bottom texts:
moulti step update my_step --top-text='Here is the output of [red bold]ip -color address[/]:'
```

--------------------------------

### View Unified Diff with Moulti

Source: https://github.com/xavierog/moulti/blob/master/README.md

This command shows a unified diff file, processed by Moulti, likely with syntax highlighting provided by the 'delta' tool. This is useful for reviewing code changes in a more readable format directly in the terminal.

```bash
diff -u a.txt b.txt | moulti diff
```

--------------------------------

### Run Ansible Playbook with Moulti

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/ansible.md

Basic usage of `moulti run` to process `ansible-playbook` output, making it more readable. This wraps the standard Ansible command.

```console
$ moulti run ansible-playbook your-playbook.yaml
```

--------------------------------

### Configure Moulti Instance with moulti set

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/subcommands.md

The `moulti set` subcommand allows configuration of various aspects of a running Moulti instance, including header title, step direction, and progress bar.

```bash
moulti set
```

--------------------------------

### Configuring Moulti Run Output Behavior

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/shell-scripting.md

Illustrates different ways to configure how Moulti handles standard output and standard error for scripts launched with `moulti run` using the `MOULTI_RUN_OUTPUT` environment variable.

```bash
# MOULTI_RUN_OUTPUT=harvest or any other value: default behavior, output is harvested.
# MOULTI_RUN_OUTPUT=discard: redirect stdout and stderr to /dev/null, discarding any output.
# MOULTI_RUN_OUTPUT=ignore: stdout and stderr are left untouched.
```

--------------------------------

### View Man Page with Moulti

Source: https://github.com/xavierog/moulti/blob/master/README.md

This command displays the manual page for a given command (e.g., 'bash') using Moulti, which adds color and potentially other TUI enhancements. This is useful for reading documentation within a structured terminal environment.

```bash
man bash | moulti manpage
```

--------------------------------

### View Diff File with Moulti Run

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/diff.md

Combines `moulti run` with `moulti diff parse` to view a diff file. This approach streamlines the process into a single command.

```shell
moulti run -- moulti diff parse /path/to/examples.diff
```

--------------------------------

### moulti-askpass: Prompt for password (Python)

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/commands.md

A helper script that prompts users for a password and prints it to standard output. Useful for integrations with SSH, Git, Ansible, or sudo.

```Python
moulti-askpass
```

--------------------------------

### Add a ButtonQuestion in Moulti

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/questions.md

Creates a ButtonQuestion widget that presents the user with a set of buttons for selection. Each button can have a different style (success, primary, default, error, warning) and a label.

```shell
moulti buttonquestion add my_second_question \
    --title='My second question with Moulti' \
    --text='What is your name?' \
    --bottom-text='What a mess: https://en.wikipedia.org/wiki/Alice_and_Bob' \
    --button alice success Alice \
    --button bob primary Bob \
    --button craig default Craig \
    --button mallory error Mallory \
    --button oscar warning Oscar
```

--------------------------------

### Execute commands as Moulti steps with moulti_exec

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/moulti-functions.md

Wraps shell commands to be executed as dedicated Moulti steps, automatically handling step creation, output capture, status updates (running, success, error), and timing. Supports configuration of step behavior via environment variables.

```bash
moulti_exec true
moulti_exec false
moulti_exec rsync -av moulti/doc/ remote:/moulti-doc/
```

--------------------------------

### Simulate GNU stdbuf on Unsupported Systems

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/moulti-functions.md

Provides a polyfill for the GNU coreutils 'stdbuf' command on systems where it's not natively available, such as NetBSD or OpenBSD (if 'unbuffer' is present). It's recommended to check availability using moulti_tool_is_available.

```bash
stdbuf command
```

--------------------------------

### Add an InputQuestion in Moulti

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/questions.md

Creates an InputQuestion widget to prompt the user for text input. It can be configured with a title, main text, helper text, and a placeholder for the input field.

```shell
moulti inputquestion add my_first_question \
    --title='My first question with Moulti' \
    --text='What is your name?' \
    --bottom-text='We want information... information... information!' \
    --placeholder='Please enter your name in this input field'
```

--------------------------------

### Pipe Output to Moulti CLI

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/design.md

Demonstrates how to pipe the output of a command to the Moulti CLI to pass step information. This showcases a common use case for Moulti's CLI interaction.

```shell
some_command --with arguments 2>&1 | moulti pass step_name
```

--------------------------------

### Verbose output of generated widgets

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/manpage.md

Shows the verbose output generated when `MOULTI_MANPAGE_VERBOSE` is set. This output details the type and ID of each divider and step widget created from the man page content, useful for scripting updates or deletions.

```console
$ MOULTI_MANPAGE_VERBOSE=y moulti manpage run -- man true
divider manpage_766397_1
step manpage_766397_2
step manpage_766397_3
step manpage_766397_4
step manpage_766397_5
step manpage_766397_6
step manpage_766397_7
step manpage_766397_8
divider manpage_766397_9
```

--------------------------------

### Configuring SSH to Use Moulti Askpass

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/shell-scripting.md

Explains how to configure SSH clients to use `moulti-askpass` for handling user interactions like host key verification and password entry by setting `SSH_ASKPASS` and `SSH_ASKPASS_REQUIRE` environment variables.

```bash
export SSH_ASKPASS=moulti-askpass
export SSH_ASKPASS_REQUIRE=force
```

--------------------------------

### Delete a Moulti Step

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/first-steps.md

Deletes a Moulti step ('error_example') entirely from the instance. This action removes the step and all its associated content.

```shell
moulti step delete error_example
```

--------------------------------

### Moulti Askpass Helper

Source: https://github.com/xavierog/moulti/blob/master/README.md

The `moulti-askpass` utility is a helper designed for use with SSH when Moulti is involved. It facilitates secure credential handling within the Moulti framework, as detailed in the documentation.

```bash
export SSH_ASKPASS="moulti-askpass"
```

--------------------------------

### View Diff Data from Command with Moulti Run

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/diff.md

Uses `moulti run` to execute an external command that generates diff data, which is then parsed by `moulti diff`. This simplifies complex diff viewing workflows.

```shell
moulti run -- moulti diff run -- diff -u /etc/passwd /etc/passwd-
```

--------------------------------

### Set Moulti Step Position to Top

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/direction-and-position.md

Configures Moulti to display steps at the top of the screen. This is a command-line operation.

```bash
moulti set --step-position=top
```

--------------------------------

### Execute a bash script with Moulti

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/shell-scripting.md

This script initializes a Moulti instance, names it, and then executes a sequence of steps. Each step captures its standard output and error streams and passes them to a corresponding Moulti pass. This pattern is useful for automating complex workflows.

```bash
#!/usr/bin/env bash

# Good practice: name the Moulti instance:
export MOULTI_INSTANCE='my-first-script-with-moulti'
# If not done already, start a Moulti instance and have it re-execute this script:
[ "${MOULTI_RUN}" ] || exec moulti run -- "$0" "$@"
moulti step add step_1 --title='First step'
{
   echo "$(date --iso-8601=ns) Starting combobulating things and stuff..."
   # your stuff here
} 2>&1 | moulti pass step_1
moulti step add step_2 --title='Second step'
{
   echo "$(date --iso-8601=ns) Ensure things and stuff were properly combobulated..."
   # more stuff there
} 2>&1 | moulti pass step_2
```

--------------------------------

### Configuring Git Askpass with Moulti

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/shell-scripting.md

Shows how to explicitly set the `GIT_ASKPASS` environment variable to `moulti-askpass` in scripts to ensure Git uses Moulti's askpass utility for credential requests.

```bash
export GIT_ASKPASS="${SSH_ASKPASS}"
```

--------------------------------

### Create Moulti Git Shell Alias

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/diff.md

Defines a shell alias `moulti-git` to simplify running Git commands through Moulti's diff functionality. This alias streamlines the process of viewing Git diffs.

```bash
# Creating the alias itself:
alias moulti-git='moulti run -- moulti diff run -- git'
```

--------------------------------

### Inspect Threads on OpenBSD

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/threads.md

This command lists running processes on OpenBSD. Thread names are appended to the 'COMMAND' column, enclosed in parentheses after a forward slash.

```bash
ps Ho pid,tid,command
```

--------------------------------

### Record Moulti Type Demo

Source: https://github.com/xavierog/moulti/blob/master/doc/assets/asciicast/HOWTO.md

This command records an asciinema session showcasing the 'moulti_type' functionality, specifically updating a step's title to appear one character at a time. It involves running bash with moulti commands and sourcing moulti-functions.bash. Note: The resulting file was manually rewritten.

```shell
asciinema rec --title='moulti_type demo' --cols=100 --rows=5 -c 'moulti run bash -c "moulti step add example --title= ; source moulti-functions.bash; moulti_type step update example --title This\ text\ appears\ one\ character\ at\ a\ time"' demo-moulti-type.cast
```

--------------------------------

### Manage Question Widgets with moulti question

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/subcommands.md

The `moulti question` subcommand manages question widgets. Specific details about these widgets can be found in the questions.md file.

```bash
moulti question
```

--------------------------------

### Assigning Default and Multiple Classes to Moulti Widgets

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/classes.md

Demonstrates how to assign single default classes or multiple custom classes to Moulti widgets using the `--classes` argument. Note that setting multiple classes overwrites existing ones.

```shell
moulti <widget> add/update <id> --classes=classname
moulti <widget> add/update <id> --classes='class1 class2 class3'
```

--------------------------------

### Source Moulti bash helpers (Bash)

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/commands.md

A library of bash helper functions for Moulti, intended to be sourced in scripts. It provides utility functions for Moulti-related tasks.

```Bash
source ~/.local/bin/moulti-functions.bash
```

--------------------------------

### Load Diff File with Moulti (CLI)

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/diff.md

Loads a specified diff file into Moulti using the command-line interface. It parses the diff content for display.

```shell
moulti diff parse /path/to/example.diff
```

--------------------------------

### Manage Step Widgets with moulti step

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/subcommands.md

The `moulti step` subcommand is used for managing step widgets. The 'First steps' and 'Steps' documentation provide detailed usage information.

```bash
moulti step
```

--------------------------------

### Manage InputQuestion Widgets with moulti inputquestion

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/subcommands.md

This subcommand, `moulti inputquestion`, is used for managing inputquestion widgets. Details on inputquestion widgets are available in the questions.md file.

```bash
moulti inputquestion
```

--------------------------------

### Manage bash standard streams with Moulti

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/shell-scripting.md

Demonstrates various methods for managing standard output and error streams in bash scripts when interacting with Moulti. Options include discarding streams, logging to a file, or piping them to Moulti steps for processing.

```bash
# Discard stdout and stderr entirely:
exec > /dev/null 2>&1
```

```bash
# Log stdout and stderr to a custom log file:
exec > custom.log 2>&1
```

```bash
# Pass stdout and stderr to a dedicated Moulti step:
moulti step add main_script_output
exec > >(moulti pass main_script_output) 2>&1
```

```bash
# Pass stdout and stderr to a dedicated Moulti step but keep a copy in a custom log file:
moulti step add main_script_output
exec > >(tee --append custom.log | moulti pass main_script_output) 2>&1
```

--------------------------------

### Enable Verbose Output for Widget IDs

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/diff.md

Activates verbose output from `moulti diff` to display the type and ID of each generated widget (steps and dividers) to standard output. This is useful for programmatic manipulation of widgets.

```console
$ MOULTI_DIFF_VERBOSE=y moulti diff run -- git show
step diff_352404_1
divider diff_352404_2
step diff_352404_3
```

--------------------------------

### Manage Moulti Dividers (Bash)

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/dividers.md

Demonstrates adding, updating, and deleting dividers using the Moulti command-line interface. Supports rich text formatting in titles.

```bash
moulti divider add my_first_divider --title \
    $'This text is simply displayed.\nMulti-line is possible. So is [i]rich formatting[/]'
moulti divider update my_first_divider --classes=warning
moulti divider delete my_first_divider
```

--------------------------------

### Running sudo with Askpass

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/shell-scripting.md

When using an askpass program with sudo, you must invoke sudo with the -A or --askpass option. This tells sudo to use the program specified by SUDO_ASKPASS for authentication.

```bash
sudo -A <command>
```

```bash
sudo --askpass <command>
```

--------------------------------

### Set Moulti Step Direction Upwards

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/direction-and-position.md

Configures Moulti to display steps from last to first, meaning new steps are added above existing ones. This is a command-line operation.

```bash
moulti set --step-direction=up
```

--------------------------------

### Programmatic Scrolling to Specific Steps

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/scrolling.md

Use the `moulti scroll` command to navigate to a specific step. You can ensure the entire step is visible or display a particular line by specifying an offset. This is often useful after adding interactive steps.

```console
# Ensure the first line of the step is displayed:
moulti scroll step_name 0
# Ensure the second line of the step is displayed:
moulti scroll step_name 1
# Ensure the third line of the step is displayed:
moulti scroll step_name 2

# Ensure the last line of the step is displayed:
moulti scroll step_name -1
# Ensure the second to last line of the step is displayed:
moulti scroll step_name -2
```

--------------------------------

### Set Moulti Step Direction Downwards

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/direction-and-position.md

Configures Moulti to display steps from first to last, meaning new steps are added below existing ones. This is a command-line operation.

```bash
moulti set --step-direction=down
```

--------------------------------

### Display Man Pages with moulti manpage

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/subcommands.md

The `moulti manpage` subcommand displays Unix man pages within the Moulti TUI interface. Consult the manpage.md documentation for more information.

```bash
moulti manpage
```

--------------------------------

### Run Diff Command via Moulti (CLI)

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/diff.md

Executes an external diff command and pipes its output directly to `moulti diff` for processing. The `--` separates Moulti commands from the command to be run.

```shell
moulti diff run -- diff -u /etc/passwd /etc/passwd-
```

--------------------------------

### Set Moulti Step Position to Bottom

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/direction-and-position.md

Configures Moulti to display steps at the bottom of the screen. This is a command-line operation.

```bash
moulti set --step-position=bottom
```

--------------------------------

### Moulti Run Script with Output Harvesting

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/shell-scripting.md

Demonstrates how a bash script uses moulti run to manage its output. The script adds steps and echoes messages, showcasing how Moulti handles output redirection based on the MOULTI_RUN_OUTPUT environment variable.

```bash
#!/usr/bin/env bash
[ "${MOULTI_RUN}" ] || exec moulti run "$0" "$@"
for i in {1..10}; do
    moulti step add $i --title "$(date '+%H:%M:%S'): step #${i}" --collapsed
    echo "$(date '+%H:%M:%S') This output is not passed to any step; where will it end?"
    sleep 1
done
```

--------------------------------

### Inspect Threads on FreeBSD

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/threads.md

This command lists detailed information about running processes and their threads on FreeBSD. The 'TDNAME' column specifically shows the thread name.

```bash
ps Ho pid,tid,tdname,command
```

--------------------------------

### moulti-man: Bash wrapper for man (Bash)

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/commands.md

A bash script that acts as a wrapper around the 'man' command, likely to provide Moulti-specific man page access or functionality.

```Bash
moulti-man
```

--------------------------------

### Process Lines into Moulti Steps

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/moulti-functions.md

Reads lines from standard input and processes them to create Moulti steps. Lines are matched against MOULTI_NEW_STEP_PATTERN and passed to either moulti_make_step or moulti_inspect_line.

```bash
moulti_process_lines
```

--------------------------------

### Pass Script Output with moulti pass

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/subcommands.md

The `moulti pass` subcommand forwards command or script output to a Moulti instance. Refer to 'First steps' and 'Steps: the art of filling Moulti steps' for guidance.

```bash
moulti pass
```

--------------------------------

### Use Moulti Git Shell Alias

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/diff.md

Demonstrates the usage of the `moulti-git` shell alias for viewing different Git states, such as the latest commit (`show`), staged changes (`diff`), or unstaged changes (`diff --cached`).

```bash
# Using it:
moulti-git show
moulti-git diff
moulti-git diff --cached
```

--------------------------------

### Collapse Ansible Tasks with Moulti

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/ansible.md

Configures Moulti to collapse Ansible tasks for concise output, allowing for easier monitoring of progress. This is achieved by setting the `MOULTI_ANSIBLE_COLLAPSE` environment variable.

```console
$ MOULTI_ANSIBLE_COLLAPSE=task moulti run ansible-playbook your-playbook.yaml
```

--------------------------------

### Bash: Customize Moulti Step Title Matching

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/existing-scripts.md

Overrides the default pattern used by Moulti to identify lines that should trigger the creation of a new step. This allows for more specific matching of section titles within a script's output.

```bash
MOULTI_NEW_STEP_PATTERN='^==== (.+) ====$'

```

--------------------------------

### Check if any command from a list is available with moulti_any_tool_is_available

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/moulti-functions.md

Checks if at least one command from a provided list (separated by '|') is available in the system's PATH or as a shell built-in. Useful for supporting multiple alternative tools.

```bash
if moulti_any_tool_is_available 'ack|hgrep|rg'; then
    echo "at least one of ack, hgrep or rg is available"
fi
```

--------------------------------

### Create Moulti Steps Programmatically

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/moulti-functions.md

A core function called by moulti_process_lines when an input line matches the step pattern. It receives context like previous step ID, suggested next step ID, the matched line, and capture groups. Implementations must print the new step ID to stdout.

```bash
moulti_make_step previous_step_id suggested_next_step_id current_line matched_substring [capture ...]
```

--------------------------------

### Show or Hide Moulti Progress Bar

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/progressbar.md

These commands control the visibility of the Moulti progress bar. The `--progress-bar` flag shows it, while `--no-progress-bar` hides it. These are CLI commands.

```shell
moulti set --progress-bar
moulti set --no-progress-bar
```

--------------------------------

### moulti-askpass-connection-password: Prompt for Ansible connection password (Python)

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/commands.md

An Ansible-specific variant of moulti-askpass for prompting the password required to establish a connection to a remote host.

```Python
moulti-askpass-connection-password
```

--------------------------------

### Inspect Threads on NetBSD

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/threads.md

This command displays system information including threads. Thread names are shown in the 'NAME' column, but this column is truncated to 9 characters.

```bash
top -t -c -U $(whoami)
```

--------------------------------

### Display Moulti Environment Variables

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/environment-variables.md

Prints the environment variables set by the Moulti instance when running a command. This is useful for debugging and understanding the execution context.

```console
$ moulti run --print-env -- true
```

--------------------------------

### Convert Gogh themes to Moulti variables

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/environment-variables.md

A bash script to convert themes from the Gogh project into environment variables compatible with Moulti's ANSI theme configuration.

```shell
tools/gogh2moulti.bash
```

--------------------------------

### Inspect Threads on Linux

Source: https://github.com/xavierog/moulti/blob/master/doc/docs/threads.md

This command uses 'pgrep' to find the process ID of the 'moulti:main' thread and then pipes it to 'pstree' to display the process tree, including thread information. 'pstree' is typically found in the 'psmisc' package.

```bash
pgrep moulti:main | xargs -n 1 pstree -napt
```
Tokens:
Raw