filep

command module
v1.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 18, 2023 License: MIT Imports: 1 Imported by: 0

README

filep

GitHub license Test codecov

filep is a file processing tool.

filep has the following subcommands

Common

The following is a description of the parts that are common to each subcommand.

Input / Output

If specified with -i, only the specified file will be processed.

$ filep replace -i input.txt -o output.txt -s a -t z

If a directory is specified, files under the directory are processed.

$ filep replace -i in_dir -o out_dir -s a -t z

The default is to process only files directly under the specified directory.
If --recursive is specified, subdirectories are processed recursively.

$ filep replace -i in_dir -o out_dir -s a -t z --recursive
Encoding

When processing non UTF-8 files, specify the encoding with --encoding.

$ filep replace -i input.txt -o output.txt -s a -t z --encoding sjis

Encoding must be one that can be specified in htmlindex.Get.

replace

Replace the contents of the input file to create an output file.

Usage
filep replace -i INPUT -o OUTPUT [-r REGEX | -s STRING] -t REPLACEMENT [--escape] [--recursive] [--encoding ENCODING]
Usage:
  filep replace [flags]

Flags:
  -i, --input string         Input file/dir path.
  -o, --output string        Output file/dir path.
  -r, --regex string         Target regex.
  -s, --string string        Target string.
  -t, --replacement string   Replacement.
      --escape               Enable escape sequence.
      --recursive            Recursively traverse the input dir.
      --encoding string      Encoding. (default "UTF-8")
  -h, --help                 help for replace
Replacement method

The target can be a regular expression or a string.

The regular expression is specified by -r.

$ filep replace -i input.txt -o output.txt -r "[0-9]" -t ""

You can also use the capture group as -t.
The following is a method for specifying "N" at the beginning of a number.

$ filep replace -i input.txt -o output.txt -r "([0-9]+)" -t "N$1"

Please refer to the following for the syntax of regular expressions.

String is specified by -s.

$ filep replace -i input.txt -o output.txt -s a -t z

To treat backslash as an escape sequence, specify --escape.

$ filep replace -i input.txt -o output.txt -s "\u3000" -t "" --escape
Binary encoding

A special encoding is binary.
If binary is specified, it can be treated as a hexadecimal character.
A hexadecimal character represents a byte with three characters prefixed by x, such as x00 or xFF.

To remove two consecutive bytes, such as 0x00 0x01, specify as follows

$ filep replace -i input.txt -o output.txt -s x00x01 -t "" --encoding binary
Note

truncate

Truncate the contents of the input file to create an output file.

Usage
filep truncate -i INPUT -o OUTPUT [-b BYTES | -c CHARS | -l LINES] [--recursive] [--encoding ENCODING]
Usage:
  filep truncate [flags]

Flags:
  -i, --input string      Input file/dir path.
  -o, --output string     Output file/dir path.
  -b, --byte int          Number of bytes.
  -c, --char int          Number of characters.
  -l, --line int          Number of lines.
      --recursive         Recursively traverse the input dir.
      --encoding string   Encoding. (default "UTF-8")
  -h, --help              help for truncate
Truncate method

The truncation size is specified in bytes, characters, or lines.

The number of bytes is specified by -b.

$ filep truncate -i input.txt -o output.txt -b 100

The number of characters is specified by -c.

$ filep truncate -i input.txt -o output.txt -c 100

The number of lines is specified by -l.

$ filep truncate -i input.txt -o output.txt -l 100
Note

extract

Extract the contents of the input file to create an output file.

Usage
filep extract -i INPUT -o OUTPUT [-s START] [-e END] [-b | -c | -l] [--recursive] [--encoding ENCODING]
Usage:
  filep extract [flags]

Flags:
  -i, --input string      Input file/dir path.
  -o, --output string     Output file/dir path.
  -s, --start int         Start position.
  -e, --end int           End position.
  -b, --byte              Handle by bytes.
  -c, --char              Handle by characters.
  -l, --line              Handle by lines.
      --recursive         Recursively traverse the input dir.
      --encoding string   Encoding. (default "UTF-8")
  -h, --help              help for extract
Extract method

Extracts a portion of a file by specifying a start and end position.
The position can be specified in bytes(-b), characters(-c), or lines(-l).

For example, if you want to extract the 3rd to 5th bytes, specify as follows

$ filep extract -i input.txt -o output.txt -s 3 -e 5 -b

Start(-s) and end(-e) can be omitted.

If start(-s) is omitted, the value is 1.
For example, if you want to extract only the first line, you can specify as follows.

$ filep extract -i input.txt -o output.txt -e 1 -l

If end(-e) is omitted, it will be at the end of the file.
For example, if you want to erase only the first character, you can specify as follows.

$ filep extract -i input.txt -o output.txt -s 2 -c
Note

Install

filep is implemented in golang and runs on all major platforms such as Windows, Mac OS, and Linux.
You can download the binaries for each OS from the links below.

You can download the binary from the following.

License

MIT

Author

onozaty

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
extract
replace
truncate

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL