cargo-coupling: Instructions file for Claude Code

cargo-coupling

Rust CLI for coupling analysis based on Khononov's "Balancing Coupling in Software Design".

Commands

# Development
cargo build --release && cargo test --all-features && cargo fmt --all && cargo clippy --all-targets --all-features -- -D warnings

# Run
cargo run -- coupling ./src          # Analyze
cargo run -- coupling --web ./src    # Web UI (:3000)
cargo run -- coupling --history ./src        # Coupling health over git history (time-series)
cargo run -- coupling --history=8 --json ./src  # Time-series as JSON (8 samples)
cargo run -- coupling --baseline main ./src  # Diff current issues against a git ref
cargo run -- coupling --check --baseline main ./src  # Ratchet gate: fail only on new High/Critical issues

# Docker
docker build -t cargo-coupling .
docker run --rm -v $(pwd):/workspace cargo-coupling coupling /workspace/src
docker compose up web

# Release
cargo fmt --all -- --check
cargo clippy --all-targets --all-features -- -D warnings
cargo test --all-features
cargo build --release
# bump Cargo.toml to X.Y.Z, refresh Cargo.lock, then:
git add Cargo.toml Cargo.lock
git commit -m "chore: release vX.Y.Z"
git tag -a vX.Y.Z -m "vX.Y.Z"
git push origin main
git push origin vX.Y.Z
# → GitHub Actions auto-publishes to crates.io

# Docker Release (manual)
gh auth refresh -h github.com -s write:packages
gh auth token | docker login ghcr.io -u nwiizo --password-stdin
docker build -t ghcr.io/nwiizo/cargo-coupling:vX.Y.Z -t ghcr.io/nwiizo/cargo-coupling:latest .
docker push ghcr.io/nwiizo/cargo-coupling:vX.Y.Z
docker push ghcr.io/nwiizo/cargo-coupling:latest

Key Files