packer/README.md

39 lines
1.0 KiB
Markdown

# packer
A simple CLI tool to find and zip file corresponding to a given regex.
**NOTE**: if you have experience using Linux bash command, prefer use `find` + `zip` command.
## Installation
* Clone the repository
```bash
git clone https://gitea.thegux.fr/rmanach/packer
```
* Build the binary
```bash
make build
```
## Usage
### Arguments
* **-r** (**required**) : filename regex
* **-o** (**required**) : full path of the zip archive output
* **-d** (**optional**) : full path of the directory to check
* **-x** (**optional**) : remove original files after successful zip
```bash
# template usage
./packer -r <regex> -o <output_path>
# zip '.log' files located in '/root/logs' directory
# 'root_log.zip' will be created in the current directory
./packer -r ^.*\.log$ -d /root/logs -o root_logs.zip
# zip '.doc' files located in the current directory
# the zip archive will be create in '/home/tutu/doc/'
# all '.doc' files will be removed after successful zip
./packer -r ^.*\.doc$ -o /home/tutu/doc/root_log.zip -x
```