Skip to content

CLAUDE.md

Latest commit

 

History

History
39 lines (28 loc) · 1.32 KB

CLAUDE.md

File metadata and controls

39 lines (28 loc) · 1.32 KB
Raw

CLAUDE.md

Build environment

Always use nix develop to run commands. This project uses a Nix flake to provide the exact toolchain (Rust, protobuf, clang, valgrind, etc.). Running commands outside the Nix shell will fail or use wrong tool versions.

nix develop --command cargo build
nix develop --command cargo check
nix develop --command cargo clippy
nix develop --command cargo build --release -p kmod-integration

Always git add new files. Nix flakes only see files tracked by git. After creating any new file, run git add <file> so that nix commands can find it.

Project structure

  • Root crate (tcpstats-reader) — FreeBSD TCP stats reader library
  • utils/tcp-echo/ — TCP echo server/client for integration testing
  • utils/tcpstats-exporter/ — Prometheus exporter for tcpstats kernel module
  • tests/kmod-integration/ — Rust-based integration test harness (replaces shell scripts)
  • kmod/tcpstats/ — FreeBSD kernel module source (C)
  • nix/ — Nix packaging, cross-compilation, VM deployment

Key commands

# Check a single crate
nix develop --command cargo check -p kmod-integration

# Lint
nix develop --command cargo clippy --workspace

# Release build
nix develop --command cargo build --release

# Run integration tests on FreeBSD VM
nix run .#integration-test-freebsd150