Expand description
System utility commands for diagnostics and services.
This module provides system-level utilities for troubleshooting, performance testing, network serving, and cryptographic operations.
§Available Commands
§Diagnostics (feature = “diagnostics”)
-
doctor: Run comprehensive system diagnostics- Check for required dependencies (QEMU, KVM, FUSE)
- Verify storage backend connectivity
- Test compression and encryption functionality
-
bench: Benchmark archive performance- Measure read throughput at various block sizes
- Test cache effectiveness
- Profile compression/decompression speed
§Network Serving (feature = “server”)
serve: Serve archives over network protocols- NBD (Network Block Device) protocol
- S3-compatible API
- HTTP range requests
§Cryptographic Operations (feature = “signing”)
keygen: Generate Ed25519 signing key pairssign: Sign archives with private keysverify: Verify archive signatures with public keys
§Usage Examples
# Check system health
hexz sys doctor
# Benchmark an archive
hexz sys bench snapshot.hxz --threads 8 --duration 60
# Serve via NBD
hexz sys serve snapshot.hxz --nbd --port 10809
# Generate and use signing keys
hexz sys keygen --output-dir ~/.hexz/keys
hexz sys sign --key ~/.hexz/keys/private.key snapshot.hxz
hexz sys verify --key ~/.hexz/keys/public.key snapshot.hxz§Feature Flags
These commands require specific feature flags to be enabled at compile time:
diagnostics: doctor, benchserver: servesigning: keygen, sign, verify
Modules§
- bench
- Implementation of the
hexz benchcommand. - doctor
- Implementation of the
hexz doctorcommand. - keygen
- Ed25519 key pair generation for archive signing.
- serve
- HTTP server for exposing Hexz snapshots over network protocols.
- sign
- Cryptographically sign Hexz archives with Ed25519 signatures.
- verify
- Verify Ed25519 signatures on Hexz archives.