grink 0.4.0

Grink is a tool to find and check web links in text files.
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

[![Crate](https://img.shields.io/crates/v/grink.svg)](https://crates.io/crates/grink)
[![Docs](https://docs.rs/grink/badge.svg)](https://docs.rs/grink)
![CI](https://github.com/bitfield/grink/actions/workflows/ci.yml/badge.svg)
![Audit](https://github.com/bitfield/grink/actions/workflows/audit.yml/badge.svg)
![Maintenance](https://img.shields.io/badge/maintenance-actively--developed-brightgreen.svg)

# grink

Grink is a tool to find and check web links in text files (for example, Markdown source files). It “greps links”, if you will.

### Installation

```sh
cargo install grink
```

### Usage

Grink reads all the files you specify, extracts anything that looks like a URL, and checks if it returns an OK status, reporting the error otherwise.

```sh
grink book/*.md
```

```txt
[ERROR] (HTTP status client error (404 Not Found) for url (https://example.com/bogus)) https://example.com/bogus - referrer: book/chapter1.md
Links: 8 (7 OK, 1 errors, 0 warnings, 0 ignored)
```

### Ignoring certain domains

If you want Grink to ignore all links to certain domains (for example, because you know that domain always returns a bogus response status), put these domains in a file, one per line, like this:

```txt
bogus.com
sketchy.com
ignoreme.com
```

Then use the `--ignore` flag to pass that domains file to Grink:

```sh
grink --ignore domains.txt book/*.md
```

```txt
Links: 8 (5 OK, 0 errors, 0 warnings, 3 ignored)
```