kaval 0.1.0

Guard your ports. A developer-focused port and process manager TUI.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

# Contributing to Kaval

Thanks for your interest in contributing!

## Development Setup

```bash
# Clone the repo
git clone https://github.com/AppachiTech/kaval.git
cd kaval

# Build
cargo build

# Run
cargo run
```

## Testing & Linting

```bash
# Run tests
make test

# Run lints (format check + clippy)
make lint
```

## Before Submitting a PR

1. Run `make lint && make test` — both must pass
2. Keep commits focused and descriptive
3. Update CHANGELOG.md under `[Unreleased]` if adding user-facing changes

## Project Structure

```
src/
  main.rs      # Entry point, CLI dispatch
  cli.rs       # clap command definitions
  models.rs    # Data structures (PortEntry, Protocol, SortField, etc.)
  scanner.rs   # Port/process scanning logic
  output.rs    # CLI table and JSON rendering
  theme.rs     # TUI color theme
  ui.rs        # Interactive TUI (ratatui)
  util.rs      # Known service detection (PROCESS_RULES / PORT_RULES)
```

## Adding a New Service

See the contributor doc block above `PROCESS_RULES` in `src/util.rs` for how to add
a new service detection rule (match variants, priority, case sensitivity).

## Reporting Issues

Use [GitHub Issues](https://github.com/AppachiTech/kaval/issues) with the provided templates.