rkik 0.3.2

Rusty Klock Inspection Kit - NTP Query and Compare Tool
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

# RKIK - Rusty Klock Inspection Kit
![Build & Tests](https://github.com/aguacero7/rkik/actions/workflows/ci-test-n-build.yml/badge.svg)
<br>
**RKIK** is a command-line tool for querying NTP servers and comparing clock offsets, written in Rust.

It allows you to:
- Query a single NTP server
- Compare two NTP servers
- Display human-readable or JSON output
- Use positional or flagged arguments (`--server`, or directly passing the hostname/IP)
- Enable verbose output for advanced details (stratum, reference ID)

---

## 🚀 Features

- ✅ Query any NTP server (IPv4 or IPv6)
- ✅ Compare offsets between two servers
- ✅ Output formats: human-readable or JSON
- ✅ Verbose mode for advanced metadata
- ✅ Accepts both FQDN and raw IP addresses
- ✅ Argument parsing via `clap` with fallback positional support

---

## 🛠 Installation

### Linux
```bash
# Download rkik-linux-x86_64.tar.gz on https://github.com/aguacero7/rkik/releases/latest
tar xvfz rkik-linux-x86_64.tar.gz 
cd rkik-linux-x86_64/
sudo mv ./rkik /usr/local/bin
```


### From Source : 
```bash
git clone <repository-url>
cd rkik
cargo build --release
sudo cp target/release/rkik /usr/local/bin
rkik --help
```

---

## 🧪 Usage Examples

| Command                                          | Description                                |
|--------------------------------------------------|--------------------------------------------|
| `rkik pool.ntp.org`                              | Query an NTP server (positional)           |
| `rkik --server pool.ntp.org`                     | Same as above, explicit flag               |
| `rkik --server time.google.com --verbose`        | Verbose query output                       |
| `rkik --server time.cloudflare.com --format json`| JSON output for a single server            |
| `rkik --compare pool.ntp.org time.google.com`    | Compare two servers                        |
| `rkik --compare ntp1 ntp2 --format json`         | Compare servers with JSON output           |

---

## 📦 Output Examples

**Human-readable:**
```
Server: time.google.com
IP: 216.239.35.0
UTC Time: Mon, 27 May 2024 13:45:00 +0000
Local Time: 2024-05-27 15:45:00
Clock Offset: -1.203 ms
Round Trip Delay: 2.320 ms
```

**JSON:**
```json
{
  "server": "time.google.com",
  "ip": "216.239.35.0",
  "utc_time": "2024-05-27T13:45:00Z",
  "local_time": "2024-05-27 15:45:00",
  "offset_ms": -1.203,
  "rtt_ms": 2.320,
  "stratum": 1,
  "reference_id": "GOOG"
}
```

---