Skip to content

Commit

Permalink
Fixed cli docs
Browse files Browse the repository at this point in the history
  • Loading branch information
andris9 committed Nov 5, 2024
1 parent 8a86e51 commit f70d1be
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions cli.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# MailAuth CLI Usage
# mailauth CLI Usage

![MailAuth Logo](https://github.com/postalsys/mailauth/raw/master/assets/mailauth.png)
![mailauth Logo](https://github.com/postalsys/mailauth/raw/master/assets/mailauth.png)

MailAuth provides a command-line utility for email authentication, complementing its [Node.js library](README.md). This guide explains how to use the MailAuth CLI to perform various email authentication tasks.
mailauth provides a command-line utility for email authentication, complementing its [Node.js library](README.md). This guide explains how to use the mailauth CLI to perform various email authentication tasks.

## Table of Contents

Expand All @@ -15,13 +15,13 @@ MailAuth provides a command-line utility for email authentication, complementing
- [`spf`](#spf) — Validate SPF for an IP address and email address
- [`vmc`](#vmc) — Validate BIMI VMC logo files
- [`bodyhash`](#bodyhash) — Generate the body hash value for an email
- [`license`](#license) — Display licenses for MailAuth and included modules
- [`license`](#license) — Display licenses for mailauth and included modules
- [DNS Cache File](#dns-cache-file)
- [License](#license)

## Installation

Install the MailAuth CLI by downloading the appropriate package for your platform or via npm:
Install the mailauth CLI by downloading the appropriate package for your platform or via npm:

- **MacOS:**
- [Intel processors](https://github.com/postalsys/mailauth/releases/latest/download/mailauth.pkg)
Expand All @@ -40,7 +40,7 @@ Install the MailAuth CLI by downloading the appropriate package for your platfor

## Getting Help

To display help information for the MailAuth CLI or any specific command, use the `--help` flag:
To display help information for the mailauth CLI or any specific command, use the `--help` flag:

```bash
mailauth --help
Expand All @@ -52,15 +52,15 @@ mailauth spf --help

## Available Commands

The MailAuth CLI offers several commands to perform different email authentication tasks:
The mailauth CLI offers several commands to perform different email authentication tasks:

1. [`report`](#report) — Validate SPF, DKIM, DMARC, ARC, and BIMI.
2. [`sign`](#sign) — Sign an email with DKIM.
3. [`seal`](#seal) — Seal an email with ARC.
4. [`spf`](#spf) — Validate SPF for an IP address and email address.
5. [`vmc`](#vmc) — Validate BIMI VMC logo files.
6. [`bodyhash`](#bodyhash) — Generate the body hash value for an email.
7. [`license`](#license) — Display licenses for MailAuth and included modules.
7. [`license`](#license) — Display licenses for mailauth and included modules.

### report

Expand Down Expand Up @@ -356,7 +356,7 @@ j+dD7whKXS1yDmyoWtvClYSyYiQ=

### license

The `license` command displays the licenses for MailAuth and its included modules.
The `license` command displays the licenses for mailauth and its included modules.

#### Usage

Expand All @@ -373,7 +373,7 @@ mailauth license
**Sample Output:**

```
MailAuth License: MIT License
mailauth License: MIT License
Included Modules:
- module1: MIT License
- module2: Apache License 2.0
Expand Down Expand Up @@ -413,7 +413,7 @@ Specify the DNS cache file using the `--dns-cache` option:
mailauth report --dns-cache /path/to/dns-cache.json email.eml
```

When this option is used, MailAuth will not perform actual DNS queries but will use the data from the cache file instead.
When this option is used, mailauth will not perform actual DNS queries but will use the data from the cache file instead.

## License

Expand Down

0 comments on commit f70d1be

Please sign in to comment.