rungs 1.0.0

Report Proportional Memory on Linux

rung -- A Tool for Fuzzy Procedures

rung is a tool help navigate "fuzzy" procedures on Linux where you might want to:

• skip certain steps if certain vague criteria are met
• repeat certain steps if they failed and trying again makes sense

You very simply specify your procedures within a single .ini file.

Quick Start: from the CLI

• If python3 -V shows v3.11 or later, install using pipx:
  • python3 -m pip install --user pipx # if pipx not installed
  • python3 -m pipx ensurepath # if needed (restart terminal)
  • pipx upgrade rung || pipx install rung # to install/upgrade
• Else for python3.10 and lesser versions, install using pip:
  • python3 -m pip install --user --upgrade rung
• To run:
  • rung # to run and show all menus
  • rung {menu-name} # run the specified menu
  • rung --edit # edit your menus

Mnemonic: step through the rungs of your laddered procedure ;-)

A Practical Example -- Manually Updating EndeavourOS

Here is an example menu for manually update an EndeavourOS:

Notes:

• Except for the first personal command, all commands are standard on EndeavourOS.
• All commands are run literally by bash except:
  • exit which means exit the menu.
  • rung {menu-name} runs rung recursively using python3
• To run a command:
  • highlight the command by typing the character before the ':' or move the cursor with the up/down arrow keys.
  • then press ENTER.
• After the command runs, the next command is highlighted and runs with just ENTER if desired.
• To, repeat and skip commands, just select another command rather than the next.
• IMPORTANT: If the menu does not fit within your terminal, then resize until it does fit.

Config: ~/.config/rung/rung.ini

Edit ~/.config/rung/rung.ini to configure your menu. The "eos-update-menu" was configured by adding this section:

[eos-update]
a: my-snaps               # replace snaps of root, home, etc 
b: reflector-simple       # update Arch mirrors
c: eos-rankmirrors        # update EndeavourOS mirrors
d: eos-update --yay       # EndeavourOS update script
e: sudo paccache -rk1; sudo paccache -ruk0 # cleanup cache
f: sudo pacman -Rns $(pacman -Qdtq)        # cleanup orphans
g: flatpak update
h: flatpak uninstall --unused; flatpak repair
i: sudo journalctl --vacuum-time=2weeks
j: sudo reboot now
x: exit

So, the config looks nearly the same as the menu, but if you specify a multiline value, then:

• the first line is shown, and
• the subsequent lines are given to bash literally.

In this manner, for very complicated commands, you can provide a summary description of what is to be run.

rung Command Line

usage: rung [-h] [-e] [-n] [menus ...]

positional arguments:
  menus          zero or more arguments

options:
  -h, --help     show this help message and exit
  -e, --edit     edit config (i.e., runs edit-rung-config)
  -n, --dry-run  do NOT do anything

Thus, you can:

• run rung -e to edit the configuration file.
• run rung with no arguments to given a menu of all the defined menus.
• provide the name specifiers of the menus to run them; each name spec can match:
  • exactly,
  • case independent exactly (if unique),
  • or case independent substring match but only at word boundaries (if unique); e.g., for the menus, ['edit-rung-config', 'example', 'eos-update']:
    • these name specs would find a menu: 'edit', 'ex', 'EOS-', 'EOS-UPDATE'
    • these name specs would NOT: 'date', 'e'.