akavel /up
Ultimate Plumber is a tool for writing Linux pipes with instant live preview
★ 8,857⑂ 131👁 95⑃ 24● 43▤ 7
+0
Daily
8,857
stars
131
forks
95
watchers
24
prs
43
issues
7
releases
README
up - the Ultimate Plumber
up is the Ultimate Plumber, a tool for writing Linux pipes in a
terminal-based UI interactively, with instant live preview of command results.
The main goal of the Ultimate Plumber is to help interactively and
incrementally explore textual data in Linux, by making it easier to quickly
build complex pipelines, thanks to a fast feedback loop. This is achieved
by boosting any typical Linux text-processing utils such as grep, sort,
cut, paste, awk, wc, perl, etc., etc., by providing a quick,
interactive, scrollable preview of their results.
Usage
Download up for Linux
| ArchLinux: aur/up
| FreeBSD: pkg install up
| macOS: brew install up
| Other OSes
To start using up, redirect any text-emitting command (or pipeline) into it
— for example:
$ lshw |& ./up
then:
- use PgUp/PgDn and Ctrl-[←]/Ctrl-[→] for basic browsing through
the command output;
- in the input box at the top of the screen, start writing any bash
pipeline; then press Enter to execute the command you typed,
and the Ultimate Plumber will immediately show you the output of
the pipeline in the scrollable window below (replacing any
earlier contents)
- For example, you can try writing:
grep network -A2 | grep : | cut -d: -f2- | paste - -
— on my computer, after pressing Enter, the screen then shows
the pipeline and a scrollable preview of its output like below:
| grep network -A2 | grep : | cut -d: -f2- | paste - -
Wireless interface Centrino Advanced-N 6235
Ethernet interface RTL8111/8168/8411 PCI Express Gigabit Ethernet Controller
- WARNING: Please be careful when using it! It could be dangerous.
In particular, writing "rm" or "dd" into it could be like running around
with a chainsaw. But you'd be careful writing "rm" anywhere in Linux
anyway, no?
- when you are satisfied with the result, you can press Ctrl-X to exit
the Ultimate Plumber, and the command you built will be written into
up1.sh file in the current working directory (or, if it already existed,
up2.sh, etc., until 1000, based on Shlemiel the Painter's
algorithm).
Alternatively, you can press Ctrl-C to quit without saving.
- If the command you piped into up is long-running (in such case you will see
a tilde ~ indicator character in the top-left corner of the screen, meaning
that up is still waiting for more input), you may need to press
Ctrl-S to temporarily freeze up's input buffer (a freeze will be
indicated by a character in top-left corner), which will inject a fake
EOF into the pipeline; otherwise, some commands in the pipeline may not print
anything, waiting for full input (especially commands like wc or sort,
but grep, perl, etc. may also show incomplete results). To unfreeze back,
press Ctrl-Q.
Additional Notes
- The pipeline is passed verbatim to a bash -c command, so any bash-isms should woTop issues
#28Readline movement support23 comments · 2018-10-29#39Add delay to unsafe-full-throttle mode6 comments · 2018-12-02#4[idea] show output from last successful command6 comments · 2018-10-24#22[idea] support for ANSI "color" escape sequences4 comments · 2018-10-26#56Safety: ptrace, seccomp, whitelists/blacklists3 comments · 2021-03-31#46Allow to change colors3 comments · 2020-03-02#44ZSH integration3 comments · 2019-07-22#40Add tab completion functionality3 comments · 2018-12-04
Latest release
v0.4 — New flags, help, new tcell v0.4 2020-10-299ddc78b upgrade version to 0.4
b20471c deps: upgrade tcell (45)
94ad570 add --noinput flag (50, 33)
3e81993 add usage info with --help flag (35)
8aa1f8f add --buf flag for specifying buffer size
3a63622 add -c flag for initial pipeline command (11)
5dc341c add -e multi-flag for custom shell
New flags:
--buf megabytes input buffer size & pipeline buffer sizes in megabytes (MiB) (default 40)
-e, --exec command command to run pipeline with; repeat multiple times to pass multi-word command; defaults to '-e=$SHELL -e=-c'
--noinput