Masking tape to help commands "do one thing well"

TL;DR

• Replace 'WORLD' to 'EARTH' on lines containing 'HELLO'

bash $ cat file | teip -g HELLO -- sed 's/WORLD/EARTH/'

• Edit 2nd field of the CSV file:

bash $ cat file.csv | teip --csv -f 2 -- tr a-z A-Z

• Edit 2nd, 3rd and 4th fields of TSV file

bash $ cat file.tsv | teip -D '\t' -f 2-4 -- tr a-z A-Z

• Convert timestamps in /var/log/secure to UNIX time

bash $ cat /var/log/secure | teip -c 1-15 -- date -f- +%s

• Edit lines containing 'hello' and the three lines before and after it

bash $ cat access.log | teip -e 'grep -n -C 3 hello' -- sed 's/./@/g'

Performance enhancement

teip allows a command to focus on its own task.

Here is the comparison of processing time to replace approx 761,000 IP addresses with dummy ones in 100 MiB text file.

See detail on wiki > Benchmark.

Features

• Help the command "do one thing well"

  • Bypassing a partial range of standard input to any command whatever you want
  • The targeted command just handles bypassed parts of the standard input
  • Flexible methods for selecting a range (Select like AWK, cut or grep)

• High performer

  • The targeted command's standard input/output are intercepted by multiple teip's threads asynchronously.
  • If general UNIX commands on your environment can process a few hundred MB files in a few seconds, then teip can do the same or better performance.

Installation

On macOS (x86_64)

Using Homebrew

bash $ brew install greymd/tools/teip

With dpkg on Ubuntu, Debian, etc (x86_64)

bash $ wget https://github.com/greymd/teip/releases/download/v2.0.0/teip-2.0.0.x86_64-unknown-linux-musl.deb $ sudo dpkg -i ./teip*.deb SHA256: dad8c44a69a8fc8406937354cd7a0ffd76679d8fb36025905ab21a8de4d1877c

With dnf on Fedora, CentOS, RHEL, etc (x86_64)

bash $ sudo dnf install https://github.com/greymd/teip/releases/download/v2.0.0/teip-2.0.0.x86_64-unknown-linux-musl.rpm SHA256: 79230c3e6d16112937967590dd730d918fa2dea02fb1e999d9f9778f625cb51e

With yum on CentOS7, RHEL7, etc (x86_64)

bash $ sudo yum install https://github.com/greymd/teip/releases/download/v2.0.0/teip-2.0.0.x86_64-unknown-linux-musl.rpm SHA256: 79230c3e6d16112937967590dd730d918fa2dea02fb1e999d9f9778f625cb51e

On Windows (x86_64)

teip command will be available on PowerShell after installing with the executable file distributed from below URL.

https://github.com/greymd/teip/releases/download/v2.0.0/teipinstaller-2.0.0-x8664-pc-windows-msvc.exe SHA256: 93548BBF27826803900ACFEFCEBDB65392D6BDCAF68BBA2D64C151A485B3A483

Attention: You may get some warning messages during the installation because this installer is not signed. Please verify manually by comparing the above hash value and one given by Get-FileHash <FileName> -Algorithm SHA256 for secure installation. Also, using teip on Windows requires some technical knowledge. See Wiki > Use on Windows.

On other UNIX or other architectures (i686, ARM, etc..)

Pre-built binary for other architectures (i686, ARM, etc..) is not prepared for now. Please build from source.

From source

With Rust's package manager cargo, you can install teip via:

$ cargo install teip

To enable Oniguruma regular expression (-G option), build with --features oniguruma option. Please make sure libclang shared library is on your environment in advance.

```bash

Example for Ubuntu

$ sudo apt install cargo clang $ cargo install teip --features oniguruma ```

```bash

Example for RHEL

$ sudo dnf install cargo clang $ cargo install teip --features oniguruma ```

```powershell

Example for Windows (PowerShell) and choco (chocolatey.org)

PS C:> choco install llvm PS C:> cargo install teip --features oniguruma ```

Usage

``` USAGE: teip -g [-oGsvz] [--] [...] teip -f [-d | -D | --csv] [-svz] [--] [...] teip -c [-svz] [--] [...] teip -l [-svz] [--] [...] teip -e [-svz] [--] [...]

OPTIONS: -c Bypassing these characters -d Use for field delimiter of -f -D Use regular expression for field delimiter of -f -e Execute on another process that will receive identical standard input as the teip, and numbers given by the result are used as line numbers for bypassing -l Bypassing these lines -f Bypassing these white-space separated fields -g Bypassing lines that match the regular expression

FLAGS: -h, --help Prints help information -v Invert the range of bypassing -G -g adopts Oniguruma regular expressions -o -g bypasses only matched parts -s Execute new command for each bypassed chunk --chomp Command spawned by -s receives standard input without trailing newlines -V, --version Prints version information -z Line delimiter is NUL instead of a newline --csv -f interprets as field number of a CSV according to RFC 4180, instead of white-space separated fields ```

Getting Started

Try this at first.

bash $ echo "100 200 300 400" | teip -f 3

The result is almost the same as the input but "300" is highlighted and surrounded by [...]. Because -f 3 specifies the 3rd field of space-separated input.

bash 100 200 [300] 400

Understand that the area enclosed in [...] is a hole on the masking tape.

Next, put the sed and its arguments at the end.

bash $ echo "100 200 300 400" | teip -f 3 sed 's/./@/g'

The result is as below. Highlight and [...] is gone then.

100 200 @@@ 400

As you can see, the sed only processed the input in the "hole" and ignores masked parts. Technically, teip passes only highlighted part to the sed and replaces it with the result of the sed.

Off-course, any command whatever you like can be specified. It is called the targeted command in this article.

Let's try the cut as the targeted command to extract the first character only.

bash $ echo "100 200 300 400" | teip -f 3 cut -c 1 teip: Invalid arguments.

Oops? Why is it failed?

This is because the cut uses the -c option. The option of the same name is also provided by teip, which is confusing.

When entering a targeted command with teip, it is better to enter it after --. Then, teip interprets the arguments after -- as the targeted command and its argument.

bash $ echo "100 200 300 400" | teip -f 3 -- cut -c 1 100 200 3 400

Great, the first character 3 is extracted from 300!

Although -- is not always necessary, it is always better to be used. So, -- is used in all the examples from here.

Now let's double this number with the awk. The command looks like the following (Note that the variable to be doubled is not $3).

bash $ echo "100 200 300 400" | teip -f 3 -- awk '{print $1*2}' 100 200 600 400

OK, the result went from 300 to 600.

Now, let's change -f 3 to -f 3,4 and run it.

bash $ echo "100 200 300 400" | teip -f 3,4 -- awk '{print $1*2}' 100 200 600 800

The numbers in the 3rd and 4th were doubled!

As some of you may have noticed, the argument of -f is compatible with the LIST of cut.

Let's see how it works with cut --help.

```bash $ echo "100 200 300 400" | teip -f -3 -- sed 's/./@/g' @@@ @@@ @@@ 400

$ echo "100 200 300 400" | teip -f 2-4 -- sed 's/./@/g' 100 @@@ @@@ @@@

$ echo "100 200 300 400" | teip -f 1- -- sed 's/./@/g' @@@ @@@ @@@ @@@ ```

Select range by character

The -c option allows you to specify a range by character-base. The below example is specifing 1st, 3rd, 5th, 7th characters and apply the sed command to them.

```bash $ echo ABCDEFG | teip -c 1,3,5,7 [A]B[C]D[E]F[G]

$ echo ABCDEFG | teip -c 1,3,5,7 -- sed 's/./@/' @B@D@F@ ```

As same as -f, -c's argument is compatible with cut's LIST.

Processing delimited text like CSV, TSV

The -f option recognizes delimited fields like awk by default.

The continuous white spaces (all forms of whitespace categorized by Unicode) is interpreted as a single delimiter.

bash $ printf "A       B \t\t\t\   C \t D" | teip -f 3 -- sed s/./@@@@/ A       B @@@@   C D

This behavior might be inconvenient for the processing of CSV and TSV.

However, the -d option in conjunction with the -f can be used to specify a delimiter. Now you can process the CSV file like this.

bash $ echo "100,200,300,400" | teip -f 3 -d , -- sed 's/./@/g' 100,200,@@@,400

In order to process TSV, the TAB character need to be typed. If you are using Bash, type $'\t' which is one of ANSI-C Quoting.

bash $ printf "100\t200\t300\t400\n" | teip -f 3 -d $'\t' -- sed 's/./@/g' 100 200 @@@ 400

teip also provides -D option to specify an extended regular expression as the delimiter. This is useful when you want to ignore consecutive delimiters, or when there are multiple types of delimiters.

bash $ echo 'A,,,,,B,,,,C' | teip -f 2 -D ',+' A,,,,,[B],,,,C

bash $ echo "1970-01-02 03:04:05" | teip -f 2-5 -D '[-: ]' 1970-[01]-[02] [03]:[04]:05

The regular expression of TAB character (\t) can also be specified with the -D option.

$ printf "100\t200\t300\t400\n" | teip -f 3 -D '\t' -- sed 's/./@/g' 100 200 @@@ 400

Regarding available notations of the regular expression, refer to regular expression of Rust.

Complex CSV processing

If you want to process a complex CSV file, such as the one below, which has columns surrounded by double quotes, use the -f option together with the --csv option.

csv Name,Address,zipcode Sola Harewatar,"Doreami Road 123 Sorashido city",12877 Yui Nagomi,"Nagomi Street 456, Nagomitei, Oishina town",26930-0312 "Conectol Motimotit Hooklala Glycogen Comex II a.k.a ""Kome kome""","Cooking dam",513123

With --csv, teip will parse the input as a CSV file according to RFC4180. Thus, you can use -f to specify column numbers for CSV files with complex structures.

For example, the CSV just mentioned above will have a "hole" as shown below.

$ cat tests/sample.csv | teip --csv -f2 Name,[Address],zipcode Sola Harewatar,["Doreami Road 123] [Sorashido city"],12877 Yui Nagomi,["Nagomi Street 456, Nagomitei, Oishina town"],26930-0312 "Conectol Motimotit Hooklala Glycogen Comex II a.k.a ""Kome kome""",["Cooking dam"],513123

Because -f2 was specified, there is a hole in the second column of each row. The following command is an example of rewriting all characters in the second column to "@".

$ cat tests/sample.csv | teip --csv -f2 -- sed 's/[^"]/@/g' Name,@@@@@@@,zipcode Sola Harewatar,"@@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@",12877 Yui Nagomi,"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@",26930-0312 "Conectol Motimotit Hooklala Glycogen Comex II a.k.a ""Kome kome""","@@@@@@@@@@@",513123

Note for --csv option:

• Double quotation " surrounding fields are also included in the holes.
• Escaped double quotes "" are treated as is; two double quotes "" are given as input to the targeted command.
• Fields containing newlines will have multiple holes, separated by newlines, instead of a single hole.
  • However, if the -s or -z option is used, it is treated as a single hole, including line breaks.

Matching with Regular Expression

You can also use -g to select a specific line matching a regular expression as the hole location.

bash $ echo -e "ABC1\nEFG2\nHIJ3" | teip -g '[GJ]\d' ABC1 [EFG2] [HIJ3]

By default, the entire line containing the pattern is the range of holes. With the -o option, the range of holes will be only at matched range.

bash $ echo -e "ABC1\nEFG2\nHIJ3" | teip -og '[GJ]\d' ABC1 EF[G2] HI[J3]

Note that -og is one of the useful idiom and frequently used in this manual.

Here is an example of using \d which matches numbers.

```bash $ echo ABC100EFG200 | teip -og '\d+' ABC[100]EFG[200]

$ echo ABC100EFG200 | teip -og '\d+' -- sed 's/.*/@@@/g' ABC@@@EFG@@@ ```

This feature is quite versatile and can be useful for handling the file that has no fixed form like logs, markdown, etc.

What commands are appropriate?

teip bypasses the string in the hole line by line so that each hole is one line of input. Therefore, a targeted command must follow the below rule.

• A targeted command must print a single line of result for each line of input.

In the simplest example, the cat command always succeeds. Because the cat prints the same number of lines against the input.

bash $ echo ABCDEF | teip -og . -- cat ABCDEF

If the above rule is not satisfied, the result will be inconsistent. For example, grep may fail. Here is an example.

```bash $ echo ABCDEF | teip -og . [A][B][C][D][E][F]

$ echo ABCDEF | teip -og . -- grep '[ABC]' ABC teip: Output of given command is exhausted

$ echo $? 1 ```

teip could not get the result corresponding to the hole of D, E, and F. That is why the above example fails.

If an inconsistency occurs, teip will exit with the error message. Also, the exit status will be 1.

To learn more about teip's behavior, see Wiki > Chunking.

Advanced usage

Solid mode

If you want to use a command that does not satisfy the condition, "A targeted command must print a single line of result for each line of input", enable "Solid mode" which is available with the -s option.

Solid mode spawns the targeted command for each hole and executes it each time.

bash $ echo ABCDEF | teip -s -og . -- grep '[ABC]'

In the above example, understand the following commands are executed in teip's internal procedure.

bash $ echo A | grep '[ABC]' # => A $ echo B | grep '[ABC]' # => B $ echo C | grep '[ABC]' # => C $ echo D | grep '[ABC]' # => Empty $ echo E | grep '[ABC]' # => Empty $ echo F | grep '[ABC]' # => Empty

The empty result is replaced with an empty string. Therefore, D, E, and F are replaced with empty as expected.

```bash $ echo ABCDEF | teip -s -og . -- grep '[ABC]' ABC

$ echo $? 0 ```

However, this option is not suitable for processing large files because of its high processing overhead, which can significantly degrade performance.

Overlay teips

Any command can be used with teip, surprisingly, even if it is teip itself.

```bash $ echo "AAA@@@@@AAA@@@@@AAA" | teip -og '@.*@' AAA[@@@@@AAA@@@@@]AAA

$ echo "AAA@@@@@AAA@@@@@AAA" | teip -og '@.*@' -- teip -og 'A+' AAA@@@@@[AAA]@@@@@AAA

$ echo "AAA@@@@@AAA@@@@@AAA" | teip -og '@.*@' -- teip -og 'A+' -- tr A _ AAA@@@@@_@@@@@AAA ```

In other words, by connecting multiple functions of teip with AND conditions, it is possible to drill holes in a more complex range. Furthermore, it works asynchronously and in multi-processes, similar to the shell pipeline. It will hardly degrade performance unless the machine faces the limits of parallelism.

Oniguruma regular expressior (-G)

If -G option is given together with -g, the regular expressin is interpreted as Oniguruma regular expression. For example, "keep" and "look-ahead" syntax can be used.

```bash $ echo 'ABC123DEF456' | teip -G -og 'DEF\K\d+' ABC123DEF[456]

$ echo 'ABC123DEF456' | teip -G -og '\d+(?=D)' ABC[123]DEF456 ```

Those techniques are helpful to reduce the number of "Overlay".

Empty hole

If a blank field exists when the -f option is used, the blank is not ignored and treated as an empty hole.

bash $ echo ',,,' | teip -d , -f 1- [],[],[],[]

Therefore, the following command can work (Note that * matches empty as well).

bash $ echo ',,,' | teip -f 1- -d, sed 's/.*/@@@/' @@@,@@@,@@@,@@@

In the above example, the sed loads four newline characters and prints @@@ four times.

Invert match (-v)

The -v option allows you to invert the range of holes. When the -f or -c option is used with -v, holes to be made in the complement of the specified field instead.

bash $ echo 1 2 3 4 5 | teip -v -f 1,3,5 -- sed 's/./_/' 1 _ 3 _ 5

Of course, it can also be used for the -og option.

bash $ printf 'AAA\n123\nBBB\n' | teip -vg '\d+' -- sed 's/./@/g' @@@ 123 @@@

External execution for match offloading (-e)

-e is the option to use external commands for pattern matching. Until the above, you had to use teip's own functions, such as -c or -g, to control the position of the holes on the masking tape. With -e, however, you can use the external commands you are familiar with to specify the range of holes.

-e allows you to specify the shell pipeline as a string. On UNIX-like OS, this pipeline is executed in /bin/sh, on Windows in cmd.exe.

For example, with a pipeline echo 3 that outputs 3, then only the third line will be bypassed.

bash $ echo -e 'AAA\nBBB\nCCC' | teip -e 'echo 3' AAA BBB [CCC]

It works even if the output is somewhat 'dirty'. For example, if any spaces or tab characters are included at the beginning of a line, they are ignored. Also, once a number is given, it does not matter if there are non-numerical characters to the right of the number.

bash $ echo -e 'AAA\nBBB\nCCC' | teip -e 'echo " 3"' AAA BBB [CCC] $ echo -e 'AAA\nBBB\nCCC' | teip -e 'echo " 3:testtest"' AAA BBB [CCC]

Technically, the first captured group in the regular expression ^\s*([0-9]+) is interpreted as a line number.

-e will also recognize multiple numbers if the pipeline provides multiple lines of numbers. For example, the seq command to display only odd numbers up to 10 is.

bash $ seq 1 2 10 1 3 5 7 9

This means that only odd-numbered rows can be bypassed by specifying the following.

bash $ echo -e 'AAA\nBBB\nCCC\nDDD\nEEE\nFFF' | teip -e 'seq 1 2 10' -- sed 's/. /@/g' @@@ BBB @@@ DDD @@@ FFF

Note that the order of the numbers must be in ascending order. Now, on its own, this looks like a feature that is just a slight development of the -l option.

However, the breakthrough of this feature is that the pipeline obtains identical standard input as teip. Thus, it can output any number using not only seq and echo, but also commands such as grep, sed, and awk, which process the standard input.

Let's look at a more concrete example. The following command is a grep command that prints the line numbers of the line containing the string "CCC" and the two lines after it.

bash $ echo -e 'AAA\nBBB\nCCC\nDDD\nEEE\nFFF' | grep -n -A 2 CCC 3:CCC 4-DDD 5-EEE

If you give this command to -e, you can punch holes in the line containing the string "CCC" and the two lines after it!

bash $ echo -e 'AAA\nBBB\nCCC\nDDD\nEEE\nFFF' | teip -e 'grep -n -A 2 CCC' AAA BBB [CCC] [DDD] [EEE] FFF

grep is not the only one. GNU sed has =, which prints the line number being processed. Below is an example of how to drill from the line containing "BBB" to the line containing "EEE".

bash $ echo -e 'AAA\nBBB\nCCC\nDDD\nEEE\nFFF' | teip -e 'sed -n "/BBB/,/EEE/="' AAA [BBB] [CCC] [DDD] [EEE] FFF

Of course, similar operations can also be done with awk.

bash $ echo -e 'AAA\nBBB\nCCC\nDDD\nEEE\nFFF' | teip -e 'awk "/BBB/,/EEE/{print NR}"'

The following is an example of combining the commands nl and tail. You can only make holes in the last three lines of input!

bash $ echo -e 'AAA\nBBB\nCCC\nDDD\nEEE\nFFF' | teip -e 'nl -ba | tail -n 3' AAA BBB CCC [DDD] [EEE] [FFF]

The -e argument is a single string. Therefore, pipe | and other symbols can be used as it is.

NUL as line delimiter (-z)

If you want to process the data in a more flexible way, the -z option may be useful. This option allows you to use the NUL character (the ASCII NUL character) instead of the newline character. It behaves like -z provided by GNU sed or GNU grep, or -0 option provided by xargs.

bash $ printf '111,\n222,33\n3\0\n444,55\n5,666\n' | teip -z -f3 -d, 111, 222,[33 3] 444,55 5,[666]

With this option, the standard input is interpreted per a NUL character rather than per a newline character. You should also pay attention to that strings in the hole are concatenated with the NUL character instead of a newline character in teip's procedure.

In other words, if you use a targeted command that cannot handle NUL characters (and cannot print NUL-separated results), the final result can be unintended.

```bash $ printf '111,\n222,33\n3\0\n444,55\n5,666\n' | teip -z -f3 -d, -- sed -z 's/.*/@@@/g' 111, 222,@@@ 444,55 5,@@@

$ printf '111,\n222,33\n3\0\n444,55\n5,666\n' | teip -z -f3 -d, -- sed 's/.*/@@@/g' 111, 222,@@@ @@@ 444,55 5,teip: Output of given command is exhausted ```

Specifying from one line to another is a typical use case for this option.

```bash $ cat test.html | teip -z -og '.*' [

$ cat test.html | teip -z -og '.*' -- grep -a BBB

Solid mode with --chomp

If -s option does not work as expected, --chomp may be helpful.

A targeted command in solid mode always accepts input with a line field (\x0A) at the end. This is because teip assumes the use of commands that return a single line of result in response to a single line of input. Therefore, even if there is no line break in the hole, a line break is given to treat it as a single line of input.

However, there are situations where this behavior is inconvenient. For example, when using commands whose behavior changes depending on the presence or absence of line field.

$ echo AAABBBCCC | teip -og BBB -s AAA[BBB]CCC $ echo AAABBBCCC | teip -og BBB -s -- tr '\n' '@' AAABBB@CCC

The above is an example where the targeted command is a "tr command that converts line field (\x0A) to @". "BBB" does not contain a newline, but the result is "BBB@", because implicitly added line breaks have been processed. To prevent this behavior, use the --chomp option. This option gives the targeted command pure input with no newlines added.

$ echo AAABBBCCC | teip -og BBB -s --chomp -- tr '\n' '@' AAABBBCCC

For example, it is useful when using commands that interpret and process input as binary like tr. Below is an example of "removing newlines from the second column of a CSV that contains newlines.

$ cat tests/sample.csv Name,Address,zipcode Sola Harewatar,"Doreami Road 123 Sorashido city",12877

The result is.

$ cat tests/sample.csv | teip --csv -f 2 -s --chomp -- tr '\n' '@' Name,Address,zipcode Sola Harewatar,"Doreami Road 123@Sorashido city",12877

Environment variables

teip refers to the following environment variables. Add the statement to your default shell's startup file (i.e .bashrc, .zshrc) to change them as you like.

TEIP_HIGHLIGHT

DEFAULT VALUE: \x1b[36m[\x1b[0m\x1b[01;31m{}\x1b[0m\x1b[36m]\x1b[0m

The default format for highlighting hole. It must include at least one {} as a placeholder.

Example: ``` $ export TEIP_HIGHLIGHT="<<<{}>>>" $ echo ABAB | teip -og A <<>>B<<>>B

ANSI Escape Sequences and ANSI-C Quoting are helpful to customize this value.

Background

Why made it?

See this post.

Why "teip"?

• tee + in-place.
• And it sounds similar to Masking-"tape".

License

Modules imported/referenced from other repositories

Thank you so much for helpful modules!

• ./src/list/ranges.rs

  • One of the module used in cut command of uutils/coreutils
  • Original souce codes are distributed under MIT license
  • The license file is on the same directory

• ./src/csv/parser.rs

  • Many parts of the source code are referenced from BurntSushi/rust-csv.
  • Original source codes are distributed under dual-licensed under MIT and Unlicense

Source code

The scripts are available as open source under the terms of the MIT License.

Logo

The logo of teip is licensed under a Creative Commons Attribution-NonCommercial 4.0 International License.