https://github.com/tamada/peripherals
peripheral utility commands for the shell.
https://github.com/tamada/peripherals
Last synced: 6 months ago
JSON representation
peripheral utility commands for the shell.
- Host: GitHub
- URL: https://github.com/tamada/peripherals
- Owner: tamada
- License: mit
- Created: 2022-07-14T03:49:25.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-05T08:56:35.000Z (over 2 years ago)
- Last Synced: 2025-03-17T11:18:58.564Z (10 months ago)
- Language: Go
- Size: 160 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# peripheral utility commands
[](https://github.com/tamada/peripherals/actions/workflows/build.yaml)
[](https://coveralls.io/github/tamada/peripherals?branch=main)
[](https://codebeat.co/projects/github-com-tamada-peripherals-main)
[](https://goreportcard.com/report/github.com/tamada/peripherals)
[](https://github.com/tamada/peripherals/blob/main/LICENSE)
[](https://github.com/tamada/peripherals/releases/tag/v1.0.1)
[](https://github.com/tamada/peripherals/releases/tag/v1.0.1)
peripheral utility commands for the shell by contrasting [GNU coreutils](https://www.gnu.org/software/coreutils/).
## How to install
This project supports Homebrew.
```sh
brew tap tamada/brew
brew install peripherals
```
## implemented commands
* [`puniq`](#puniq)
* [`ptake`](#ptake)
* [`pskip`](#pskip)
* [`ptest`](#ptest)
* [`snip`](#snip)
### `puniq`
```sh
puniq [OPTIONS] [INPUT [OUTPUT]]
OPTIONS
-a, --adjacent delete only adjacent duplicated lines.
-d, --delete-lines only prints deleted lines.
-i, --ignore-case case sensitive.
-h, --help print this message.
INPUT gives file name of input. If argument is single dash ('-')
or absent, the program read strings from stdin.
OUTPUT represents the destination.
```
### `ptake`
```sh
ptake [OPTIONS] [FILEs...]
OPTIONS
-b, --bytes take NUMBER bytes (same as head command).
-n, --lines take NUMBER lines (same as head command).
-u, --until take lines until KEYWORD is appeared.
-w, --while take lines while PREDICATE is satisfied.
we can use the variable PLINE and PLINECOUNT
which are the current line and its line number in the PREDICATE.
-q, --no-header suppress printing of headers when multiple files are being examined.
-h, --help print this message and exit.
FILE
gives file name for the input. if this argument is single dash ("-") or absent,
it reads strings from STDIN.
if more than a single file is specified, each file is separated by a header
consisting of the string "==> XXX <==" where "XXX" is the name of the file.
```
### `pskip`
```shell
skip [OPTIONS] [FILEs...]
OPTIONS
-b, --bytes skip NUMBER bytes (same as head command).
-n, --lines skip NUMBER lines (same as head command).
-u, --until skip lines until KEYWORD is appeared.
-w, --while skip lines while PREDICATE is satisfied.
we can use the variable PLINE and PLINECOUNT
which are the current line and its line number in the PREDICATE.
-q, --no-header suppress printing of headers when multiple files are being examined.
-h, --help print this message and exit.
FILE
gives file name for the input. if this argument is single dash ("-") or absent,
it reads strings from STDIN.
if more than a single file is specified, each file is separated by a header
consisting of the string "==> XXX <==" where "XXX" is the name of the file.
```
### `ptest`
```shell
ptest
file operation
-b file true if file exists and is a block special file.
-c file true if file exists and is a character special file.
-d file true if file exists and is a directory.
-e file true if file exists (regardless of type).
-f file true if file exists and is a regular file.
-g file true if file exists and its set group ID flag is set.
-k file true if file exists and its sticky bit is set.
-p file true if file is a named pipe (FIFO).
-r file true if file exists and is readable.
-s file true if file exists and has a size greater than zero.
-t file_descriptor true if the file whose file descriptor number is file_descriptor is open and is
associated with a terminal.
-u file true if file exists and its set user id flag is set.
-w file true if file exists and is writable.
-x file true if file exists and is executable. If file is directory,
true indicates that file can be searched.
-L file true if file exists and its a symbolic link.
-O file true if file exists and its owner matches the effective user id of this process (not support on Windows platform).
-G file true if file exists and its group matches the effective group id of this process (not support on Windows platform).
-S file true if file exists and its a socket.
file1 -nt file2 true if file1 exists and is newer than file2.
file1 -ot file2 true if file1 exists and is older than file2.
file1 -ef file2 true if file1 and file2 exist and refer to the same file.
string operation
-n string true if the length of string is nonzero.
-z string true if the length of string is zero.
string true if string is not the null string.
s1 = s2 true if the strings s1 and s2 are identical.
s1 == s2 true if the strings s1 and s2 are identical, same as s1 = s2.
s1 != s2 true if the strings s1 and s2 are not identical.
s1 -starts s2 true if string s1 starts with s2.
s1 -ends s2 true if string s1 ends with s2.
s1 -contains s2 true if string s1 contains s2.
s1 < s2 true if string s1 comes before s2 based on the binary value of their characters.
s1 <= s2 true if string s1 comes before or equals to s2 based on the binary value of their characters.
s1 > s2 true if string s1 comes after s2 based on the binary value of their characters.
s1 >= s2 true if string s1 comes after or equals to s2 based on the binary value of their characters.
numeric operation
n1 -eq n2 true if the integers n1 and n2 are algebraically equal.
n1 -ne n2 true if the integers n1 and n2 are not algebraically equal.
n1 -gt n2 true if the integers n1 is algebraically greater than the integer n2.
n1 -ge n2 true if the integers n1 is algebraically greater than or equals to the integer n2.
n1 -lt n2 true if the integers n1 is algebraically less than the integer n2.
n1 -le n2 true if the integers n1 is algebraically less than or equals to the integer n2.
combined operation
! expression true if the expression is false.
expression -a expression true if both expression1 and expression2 are true. The -a operator has higher precedence than the -o operator.
expression -o expression true if either expression1 or expression2 are true. The -o operator has lower precedence than the -a operator.
( expression ) true if expression is true
```
### `snip`
`snip` command is synthesis of `head` and `tail` command.
```shell
snip [OPTIONS] [FILEs...]
OPTIONS
-H, --head int print first HEAD lines (same as head command). (default -1)
-T, --tail int print last TAIL lines (same as tail command). (default -1)
-N, --number int print first and last lines (default is 5). (default 5)
-n, --line-number print line number with output lines.
-s, --no-snip-sign suppress printing of snip sign and the number of snipped lines.
-q, --no-header suppress printing of headers when multiple files are being examined.
-h, --help print this message and exit
-v, --version print the version information and exit
FILE
gives file name for the input. if this argument is single dash ('-') or absent,
it reads strings from STDIN.
if more than a single file is specified, each file is separated by a header
consisting of the string '==> XXX <==' where 'XXX' is the name of the file.
```
## License
[](https://github.com/tamada/peripherals/blob/main/LICENSE)