logrotate 1.0.1

Cli tool for rotating / archiving files within specified directory.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

# Logrotate - Unique Fork Written in Rust

_Taking inspiration from the Linux tool:
https://linux.die.net/man/8/logrotate_

---

[![Rust](https://img.shields.io/badge/rust-%23000000.svg?style=for-the-badge&logo=rust&logoColor=white)](https://www.rust-lang.org/)

## Intent:

Slim version of a logrotate cli utility for: 
archiving, removing, and truncating files in a provided directory.

## Usage:

```
    logrotate --help
    Cli tool for rotating files within specified directory.
    
    Usage: logrotate [OPTIONS] --archive-method <ARCHIVE_METHOD> --directory <DIRECTORY> --keep-days <DAYS>
    
    Options:
          --dry-run
              Perform a dry run without making any changes Will output files marked for deletion, archival, and truncation
      -a, --archive-method <ARCHIVE_METHOD>
              Archival method to use [possible values: tar, tar-gunzip, zip]
      -d, --directory <DIRECTORY>
              Directory to parse through
      -k, --keep-days <DAYS>
              Number of days to keep archived files [default: 7]
      -h, --help
              Print help
      -V, --version
              Print version
```

---

## Support:

|    File Extension     | Supported | Planned |
|:---------------------:|:---------:|:-------:|
|      log / logs       |     ✅     |    -    |
|      txt / text       |     ✅     |    -    |
|          bin          |     ❌     |    ❌    |
|          xml          |     ✅     |    -    |
|          csv          |     ✅     |    -    |
|         json          |     ✅     |    -    |
|          elf          |     ❌     |    ❌    |
|          cef          |     ✅     |    -    |
|          clf          |     ✅     |    -    |
|        syslog         |     ✅      |    -    |
| Any Unnamed Extension |     ❌     |    ❓    |

---

## Build Locally:

_Requires Rust (minimum stable-2024 & any-architecture)_

```bash
    git clone https://github.com/jackpots28/logrotate.git
    cd logrotate
    cargo build --profile release
    sudo cp target/release/logrotate /usr/bin
```

Built binary is ~2Mb on disk

## Install Prebuilt:

Brew (MacOS):
```bash
    TBD
```

Linux (Fedora / CentOS / RHEL / Rocky - dnf or yum | *x86-64, aarch64, ppc64le*):
```bash
    TDB
```

Linux (Debian - apt | *x86-64, aarch64*):
```bash
    TBD
```

Windows (x86-64 assumed):
```bash
    TBD
```

Crates.io
```bash
    https://crates.io/crates/logrotate
```