https://github.com/sfcompute/hardware_report
Produces a serialized hardware report of the physical infrastructure for automation
https://github.com/sfcompute/hardware_report
hardware orchestration report server virtualization
Last synced: 10 days ago
JSON representation
Produces a serialized hardware report of the physical infrastructure for automation
- Host: GitHub
- URL: https://github.com/sfcompute/hardware_report
- Owner: sfcompute
- License: apache-2.0
- Created: 2024-11-05T01:26:54.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-12-30T23:31:12.000Z (28 days ago)
- Last Synced: 2026-01-03T22:57:21.774Z (24 days ago)
- Topics: hardware, orchestration, report, server, virtualization
- Language: Rust
- Homepage:
- Size: 3.32 MB
- Stars: 26
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Notice: NOTICE
Awesome Lists containing this project
README
[](https://www.rust-lang.org) [](https://nixos.org) [](https://kernel.org)
# Hardware Report
**Automated infrastructure discovery tool built with hexagonal architecture.**
Generates structured hardware inventory reports in TOML/JSON format. Designed for CMDB population, infrastructure auditing, and bare-metal server management at 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://github.com/sfcompute/hardware_report.git
cd hardware_report
nix build
sudo ./result/bin/hardware_report
```
Output: `_hardware_report.toml`
**Pre-built .deb package:** Download from [GitHub Releases](https://github.com/sfcompute/hardware_report/releases)
**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
[MIT](LICENSE)
---
**Built for infrastructure management at scale** | [Issues](https://github.com/sfcompute/hardware_report/issues) | [Releases](https://github.com/sfcompute/hardware_report/releases)