Skip to content

Chore/repo hygiene #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
YehiaGewily merged 3 commits into from
Jul 21, 2026
Merged

Chore/repo hygiene #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c207c2c
chore: untrack runtime UI state files
YehiaGewily Jul 21, 2026
c463423
chore: add MIT LICENSE and include it in release packages
YehiaGewily Jul 21, 2026
8c6e027
docs: complete the CLI flag table and drop the screenshot TODO
YehiaGewily Jul 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,10 @@ _CPack_Packages/
*.ipr

# --- Runtime / Application Output ---
# Written by the app at exit; per-machine state, not project configuration.
imgui.ini
netprobe-layout.ini
netprobe-settings.ini

# --- GeoIP Data and Local Secrets ---
# GeoLite databases are user-supplied/downloaded and must not be committed.
Expand Down
2 changes: 2 additions & 0 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,10 +284,12 @@ install(TARGETS NetProbe NetProbeCli
BUNDLE DESTINATION .
)
install(DIRECTORY data/ DESTINATION data)
install(FILES "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE" DESTINATION .)

set(CPACK_GENERATOR "ZIP")
set(CPACK_PACKAGE_FILE_NAME "NetProbe-${PROJECT_VERSION}-${CMAKE_SYSTEM_NAME}")
set(CPACK_INCLUDE_TOPLEVEL_DIRECTORY OFF)
set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE")
include(CPack)

# --- 7.5 Sample PCAP generator ---
Expand Down
21 changes: 21 additions & 0 deletions LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2025-2026 Yehia Gewily

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
16 changes: 6 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,6 @@ A real-time and offline network traffic analyzer built with **Modern C++20**, **

> Every push is built on Windows, Linux, and macOS, run under AddressSanitizer and UndefinedBehaviorSanitizer, checked with clang-tidy, and fuzzed with libFuzzer.

<!--
TODO(screenshots): a hero image belongs here — see plans/IMPLEMENTATION_PLAN.md
Phase 1. Capture at 1600x900 in the dark theme, save under docs/screenshots/,
and reference them here and beside the feature list below.
-->


## Download

Download the ZIP for your platform from [GitHub Releases](https://github.com/YehiaGewily/netprobe-cpp/releases). Windows releases require the [Npcap driver](https://npcap.com/#download) for live capture and PCAP support. Linux and macOS releases require their system libpcap runtime.
Expand Down Expand Up @@ -140,9 +133,12 @@ netprobe-cli -r capture.pcap -o - | jq '.flows[] | select(.bytes_down > 100000)'
| `-f, --filter <bpf>` | BPF capture filter, live capture only |
| `-o, --output <path>` | Destination file, or `-` for stdout |
| `--format <json\|csv>` | Override the format inferred from the extension |
| `--duration <sec>` | Stop after this many seconds |
| `--packet-count <n>` | Stop after this many packets |
| `--duration <sec>` | Stop after this many seconds, live capture only |
| `--packet-count <n>` | Stop after this many packets, live capture only |
| `--no-process` | Skip the owning-process lookup |
| `--list-devices` | List the capture adapters and exit |
| `-h, --help` | Show the full usage text and exit |
| `-V, --version` | Show the version and exit |

Ctrl+C stops a live capture and still writes the output. Exit codes are `0` success, `1` usage error, `2` runtime failure, so scripts can tell a bad invocation from a failed capture. Diagnostics go to stderr, which keeps `-o -` output clean for piping.

Expand Down Expand Up @@ -219,5 +215,5 @@ Contributions are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for build inst

## License

This project is licensed under the MIT License.
This project is licensed under the MIT License — see [LICENSE](LICENSE) for the full text.

49 changes: 0 additions & 49 deletions imgui.ini
View file
Open in desktop

This file was deleted.

2 changes: 0 additions & 2 deletions netprobe-settings.ini
View file
Open in desktop

This file was deleted.

Loading