|
4 | 4 |
|
5 | 5 | ## Setup & Environment |
6 | 6 | ```bash |
7 | | -make setup # One-time development environment setup (installs tools, fetches deps) |
8 | | -mise trust && mise install # Alternative: manual tool installation via mise |
| 7 | +mise trust && mise install # One-time tool installation via mise |
| 8 | +cargo fetch # Fetch dependencies |
9 | 9 | ``` |
10 | 10 |
|
11 | 11 | ## Running the Engine |
12 | 12 | ```bash |
13 | | -make dev # Start dev server with auto-reload (cargo watch) |
14 | | -make run # Run engine in debug mode |
15 | | -cargo run --bin inferadb-engine # Direct cargo command |
| 13 | +cargo run --bin inferadb-engine # Run engine in debug mode |
| 14 | +cargo watch -x 'run --bin inferadb-engine' # Dev server with auto-reload |
16 | 15 | ``` |
17 | 16 |
|
18 | 17 | ## Building |
19 | 18 | ```bash |
20 | | -make build # Debug build |
21 | | -make release # Release build (optimized) |
22 | | -cargo build --release --workspace # Direct cargo command |
| 19 | +cargo build # Debug build |
| 20 | +cargo build --release # Release build (optimized) |
23 | 21 | ``` |
24 | 22 |
|
25 | 23 | ## Testing |
26 | 24 | ```bash |
27 | | -make test # Run unit tests (cargo nextest) |
28 | | -make test-integration # Run integration tests |
29 | | -make test-fdb # Run FoundationDB integration tests (requires Docker) |
30 | | -make test-aws # Run AWS Secrets Manager tests (requires Docker) |
31 | | -make test-gcp # Run GCP Secret Manager tests (requires Docker) |
32 | | -make test-azure # Run Azure Key Vault tests (requires Docker) |
33 | | -make coverage # Generate code coverage report |
| 25 | +cargo nextest run --lib --workspace # Run unit tests |
| 26 | +cargo nextest run --test '*' --workspace # Run integration tests |
| 27 | +cargo test --doc --all-features # Run doc tests |
| 28 | +./docker/fdb-integration-tests/test.sh # FoundationDB integration tests |
| 29 | +./docker/aws-integration-tests/test.sh # AWS Secrets Manager tests |
| 30 | +./docker/gcp-integration-tests/test.sh # GCP Secret Manager tests |
| 31 | +./docker/azure-integration-tests/test.sh # Azure Key Vault tests |
| 32 | +cargo llvm-cov --workspace --html # Generate code coverage report |
34 | 33 | ``` |
35 | 34 |
|
36 | 35 | ## Code Quality |
37 | 36 | ```bash |
38 | | -make check # Run all quality checks (format, lint, audit) |
39 | | -make format # Format code (cargo +nightly fmt) |
40 | | -make lint # Run clippy linter |
41 | | -make audit # Run security audit |
42 | | -make deny # Check dependencies with cargo-deny |
43 | | -make fix # Auto-fix clippy warnings |
| 37 | +cargo +nightly fmt --all # Format code |
| 38 | +cargo clippy --workspace --all-targets -- -D warnings # Lint |
| 39 | +cargo audit # Security audit |
| 40 | +cargo deny check # Dependency checks |
| 41 | +cargo clippy --fix --allow-dirty --allow-staged # Auto-fix warnings |
44 | 42 | ``` |
45 | 43 |
|
46 | 44 | ## Benchmarks & Analysis |
47 | 45 | ```bash |
48 | | -make bench # Run benchmarks |
49 | | -make doc # Generate documentation |
50 | | -make tree # Show dependency tree |
51 | | -make outdated # Check for outdated dependencies |
52 | | -make bloat # Analyze binary size (requires cargo-bloat) |
| 46 | +cargo bench --workspace # Run benchmarks |
| 47 | +cargo doc --workspace --no-deps # Generate documentation |
| 48 | +cargo tree --workspace # Show dependency tree |
| 49 | +cargo update --workspace --dry-run # Check for outdated deps |
53 | 50 | ``` |
54 | 51 |
|
55 | 52 | ## Docker & Kubernetes |
56 | 53 | ```bash |
57 | | -make docker-build # Build Docker image |
58 | | -make docker-run # Run Docker container |
59 | | -make k8s-deploy # Deploy to local Kubernetes |
60 | | -make k8s-delete # Delete from Kubernetes |
| 54 | +docker build -t inferadb-engine:dev . # Build Docker image |
| 55 | +docker run -p 8080:8080 -p 8081:8081 inferadb-engine:dev # Run container |
| 56 | +kubectl apply -k k8s/ # Deploy to Kubernetes |
| 57 | +kubectl delete -k k8s/ # Delete from Kubernetes |
61 | 58 | ``` |
62 | 59 |
|
63 | 60 | ## Cleanup |
64 | 61 | ```bash |
65 | | -make clean # Clean build artifacts |
66 | | -make reset # Full reset of dev environment (Docker, cargo, etc.) |
67 | | -``` |
68 | | - |
69 | | -## CI Simulation |
70 | | -```bash |
71 | | -make ci # Simulate full CI pipeline locally |
| 62 | +cargo clean # Clean build artifacts |
72 | 63 | ``` |
73 | 64 |
|
74 | 65 | ## Unix Utilities (Darwin/macOS) |
|
0 commit comments