21 releases

0.1.37 Jan 11, 2023
0.1.35 Jun 18, 2022
0.1.33 Nov 15, 2021
0.1.31 Jun 24, 2021
0.1.26 Mar 22, 2021

#879 in Text processing

Used in aki-txpr-macro


666 lines


crate Docs Rust Version Apache2/MIT licensed

the substitude text program.


  • the substitude text command, replace via regex.
  • minimum support rustc 1.56.1 (59eed8a2a 2021-11-01)

Command help

aki-gsub --help
  aki-gsub [options]

substitude text command, replace via regex.

      --color <when>    use markers to highlight the matching strings
  -e, --exp <exp>       regular expression
  -f, --format <fmt>    replace format
  -n, --quiet           no output unmach lines

  -H, --help        display this help and exit
  -V, --version     display version information and exit

Option Parameters:
  <when>    'always', 'never', or 'auto'
  <exp>     regular expression can has capture groups
  <fmt>     format can has capture group: $0, $1, $2, ...

  AKI_GSUB_COLOR_SEQ_ST     color start sequence specified by ansi
  AKI_GSUB_COLOR_SEQ_ED     color end sequence specified by ansi

  Leaving one character between 'a' and 'c', converts 'a' and 'c'
  on both sides to '*':
    echo "abcabca" | aki-gsub -e "a(.)c" -f "*\$1*"
  result output:

  Converts 'a' to '*' and 'c' to '@':
    echo "abcabca" | aki-gsub -e "a" -f "*" -e "c" -f "@"
  result output:

Quick install

  1. you can install this into cargo bin path:
cargo install aki-gsub
  1. you can build debian package:
cargo deb

and install .deb into your local repository of debian package.


Example 1: simple replacements

Leaving one character between 'a' and 'c', converts 'a' and 'c' on both sides to '*'.

command line:

echo "abcabca" | aki-gsub -e "a(.)c" -f "*\$1*"

result output:


The \$1 mean 1st capture.

Example 2: extracting email address

This extracts the email address and prints the name and address in commas.

command line:

echo "From:Red bear<aki.akaguma@example.com>" | aki-gsub -e "From: ?(.*)<([\w\d_.-]+@[\w\d_-]+\.[\w\d._-]+)>" -f "\$1, \$2"

result output:

Red bear, aki.akaguma@example.com

The \$1 mean 1st capture. The \$2 mean 2nd capture.

Example 3: multiple format

You can specify multiple formats. See following.

command line:

echo "xxx yyy zzz" | aki-gsub -e "x(x)x" -f "a\$1a" -e "y(y)y" -f "b\$1b"

result output:

axa byb zzz

The \$1 mean 1st capture.

Library example

See fn execute() for this library examples.


This crate's changelog here.


This project is licensed under either of

at your option.


~83K SLoC