dmarc-report-parser 0.2.0

An RFC 7489-compliant DMARC aggregate report parser
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

# CLI usage

The `dmarc-report` binary is an optional CLI tool for rendering DMARC aggregate
reports in the terminal, as HTML, or as Markdown. It is built when the `cli`
Cargo feature is enabled.

## Installation

```sh
cargo install dmarc-report-parser --features cli
```

## Synopsis

```text
dmarc-report [OPTIONS] <FILES>...
```

### Arguments

| Argument | Description |
|----------|-------------|
| `<FILES>...` | One or more DMARC report files (`.xml`, `.xml.gz`, `.gz`, or `.zip`). When more than one file is given, the output is an aggregate view across all of them. |

### Options

| Option | Default | Description |
|--------|---------|-------------|
| `-f`, `--format <FORMAT>` | `terminal` | Output format: `terminal`, `html`, or `markdown` |
| `-o`, `--output <FILE>` | stdout | Write rendered output to a file |
| `-h`, `--help` | | Print help information |
| `-V`, `--version` | | Print version |

## Output formats

### Terminal (default)

Produces colorized, human-readable output suitable for viewing in a terminal
emulator. Passing and failing results are highlighted with colors.

```sh
dmarc-report report.xml
```

### HTML

Generates a standalone HTML document with embedded CSS styles. This can be
opened directly in a browser or served from a web server.

```sh
dmarc-report report.xml --format html --output report.html
```

### Markdown

Renders the report as Markdown tables. Useful for pasting into issues, wikis,
or other documentation.

```sh
dmarc-report report.xml.gz --format markdown
```

## Supported input formats

The CLI automatically detects the file format from the file extension:

| Extension | Handling |
|-----------|----------|
| `.xml` | Parsed directly as XML |
| `.gz`, `.xml.gz` | Decompressed with gzip, then parsed |
| `.zip` | The first `.xml` entry is extracted and parsed |

## Aggregating multiple reports

Pass two or more files to render them as a single aggregate view. The output
contains:

- An **overview** with the total reports, records, messages, and the combined
  date span.
- A **reports** section listing each contributing report (organisation,
  report ID, domain, period, record and message counts).
- A combined **records** table with an extra `Report` column that identifies
  which report each row came from.

Each report retains its own metadata; nothing is fabricated by combining
fields like `policy_published` across reports.

```sh
# Aggregate every gzip-compressed report in the current directory
dmarc-report *.xml.gz

# Render an aggregate as a single HTML document
dmarc-report q1/*.xml q2/*.xml --format html --output combined.html
```

## Examples

```sh
# View a plain XML report in the terminal
dmarc-report report.xml

# View a gzip-compressed report
dmarc-report report.xml.gz

# Extract and view a report from a zip archive
dmarc-report report.zip

# Save an HTML report to disk
dmarc-report report.xml --format html --output report.html

# Pipe Markdown output into another tool
dmarc-report report.xml --format markdown | less

# Aggregate multiple reports into one Markdown table
dmarc-report jan/*.xml.gz --format markdown
```