hardware_report 0.1.7

Hardware inventory reports for observability and cluster acceptance testing
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

[![Rust](https://img.shields.io/badge/rust-%23000000.svg?style=for-the-badge&logo=rust&logoColor=white)](https://www.rust-lang.org) [![Nix](https://img.shields.io/badge/nix-%23000000.svg?style=for-the-badge&logo=nixos&logoColor=white)](https://nixos.org) [![Linux](https://img.shields.io/badge/linux-%23000000.svg?style=for-the-badge&logo=linux&logoColor=white)](https://kernel.org)

# Hardware Report

**Automated infrastructure discovery tool built with hexagonal architecture.**

Generates structured hardware inventory reports in TOML/JSON format. Designed to power observability, cluster acceptance testing, CMDB population, infrastructure auditing, and bare-metal server management at AI NeoClouds scale.

**Platforms:** Linux, macOS | **Architectures:** x86_64, ARM64 | **GPUs:** NVIDIA (including Blackwell)

## Table of Contents

- [What Does This Do?](#what-does-this-do)
- [Quick Start](#quick-start)
- [Documentation](#documentation)
- [Contributing](#contributing)
- [License](#license)

## What Does This Do?

- **CPU Discovery** - Model, sockets, cores, threads, NUMA topology, cache hierarchy
- **Memory Detection** - Total capacity, module details, DDR type, speed, slot mapping
- **Storage Enumeration** - NVMe/SSD/HDD detection, capacity, serial numbers, SMART status
- **GPU Detection** - NVIDIA via nvidia-smi, memory, PCI topology, UUIDs
- **Network Interfaces** - MAC/IP, speed (1G-400G+), InfiniBand, driver info
- **System Information** - BIOS, BMC/IPMI, chassis serial, motherboard specs

## Quick Start

**Recommended: Nix build** (automatically handles all dependencies)

```bash
# Install Nix (if not already installed)
curl -L https://install.determinate.systems/nix | sh -s -- install
. /nix/var/nix/profiles/default/etc/profile.d/nix-daemon.sh

# Clone, build, and run
git clone https://codeberg.org/kennysheridan/hardware_report.git
cd hardware_report
nix build
sudo ./result/bin/hardware_report
```

Output: `<chassis_serial>_hardware_report.toml`

**Cargo install:** `cargo install hardware_report`

**Other installation methods:** See [docs/INSTALLATION.md](docs/INSTALLATION.md)

## Documentation

| Document | Description |
|----------|-------------|
| [docs/INSTALLATION.md](docs/INSTALLATION.md) | All installation methods (Nix, Cargo, pre-built releases) |
| [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) | Hexagonal architecture overview |
| [docs/API.md](docs/API.md) | Library API reference |
| [docs/DEPLOYMENT.md](docs/DEPLOYMENT.md) | Production deployment guide |

## Contributing

```bash
nix develop
cargo test && cargo clippy && cargo fmt
```

## License

[Apache-2.0](LICENSE)

---

**Built for infrastructure management at AI NeoClouds scale** | [Source](https://codeberg.org/kennysheridan/hardware_report) | [Issues](https://codeberg.org/kennysheridan/hardware_report/issues)