nhs-number-cli 0.3.0

Command line tool that validates United Kingdom (UK) National Health Service (NHS) Numbers, one per line, from standard input.
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

# NHS Number command line interface

A National Health Service (NHS) Number is a unique ten-digit identifier
allocated to registered patients of NHS England and the NHS Isle of Man.

This tool is a command line interface that parses each standard input line into
an NHS number, then validates the check digit is correct.

* If the line is a valid NHS number, then print it.

* If the line is an invalid NHS Number, or is unparseable, then print an error message.

* If the line is blank, then skip it.

References:

* [National Health Service (NHS)](https://en.wikipedia.org/wiki/National_Health_Service)

* [NHS Number](https://en.wikipedia.org/wiki/NHS_number)

## Examples

Suppose you have a text file `input.txt` that contains one NNS Number per line,
and some may be valid or invalid:

```txt
999 999 9999
999 123 4561
```

If you use Linux or macOS, then here's how to parse each line and validate it:

```sh
cat input.txt | nhs-number-cli
```

If you use Windows, then here's how to parse each line and validate it:

```sh
type input.txt | nhs-number-cli.exe
```

The commmand prints the valid NHS Number to stdout:

```stdout
999 999 9999
```

The commmand prints the invalid NHS Number to stderr:

```stderr
Error invalid line 1. Error: validate check digit failed. NHS Number: 999 123 4561
```

## Releases

You can build a release for your own platform:

```sh
cargo build --release
```

You can download a prebuilt release for Windows:

* Windows with GNU: <target/x86_64-pc-windows-gnu/release/nhs-number-cli.exe>

We aim to add more prebuilt releases soon.

## Documentation

Full documentation lives under [`docs/`](./docs/):

* [About NHS Numbers](./docs/about-nhs-numbers.md)
* [Installation](./docs/installation.md)
* [Usage](./docs/usage.md)
* [Examples](./docs/examples.md)
* [Troubleshooting](./docs/troubleshooting.md)
* [Architecture](./docs/architecture.md)
* [Development](./docs/development.md)
* [FAQ](./docs/faq.md)

Runnable examples with expected-output fixtures and `run.sh` scripts
live under [`examples/`](./examples/). Run them all with:

```sh
cargo build
./examples/run-all.sh
```

## For AI coding agents

See [`AGENTS.md`](./AGENTS.md) for conventions, the behavioural
contract, and things to avoid when modifying this repository with the
help of AI tools.