Skip to content

Commit 6e9dbfd

Browse files
committed
initial commit
0 parents  commit 6e9dbfd

18 files changed

Lines changed: 4183 additions & 0 deletions
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Bug report
3+
about: Report a UI problem or incorrect filter
4+
title: "[Bug] "
5+
labels: bug
6+
---
7+
8+
## What is wrong?
9+
10+
## Expected behavior or filter
11+
12+
## Wireshark version / browser
13+
14+
## Official reference, if this is a filter correction

.github/workflows/validate.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: Validate
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches: ["main"]
7+
8+
permissions:
9+
contents: read
10+
11+
jobs:
12+
filters:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v7
16+
- run: python3 scripts/validate_filters.py

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.DS_Store
2+
.vscode/
3+
.idea/
4+
__pycache__/
5+
*.log

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Contributing
2+
3+
Corrections and useful additions are welcome.
4+
5+
1. Edit `data/filters.json`.
6+
2. Keep display-filter and capture-filter syntax in the correct mode.
7+
3. Prefer concise descriptions that explain what the filter surfaces.
8+
4. Run:
9+
10+
```bash
11+
python3 scripts/build_data.py
12+
python3 scripts/validate_filters.py
13+
```
14+
15+
5. Test `index.html` locally.
16+
17+
For syntax corrections, cite the relevant official Wireshark documentation in the pull request.

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Wireshark Filters contributors
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Wireshark Filters
2+
3+
A searchable local reference for Wireshark display filters, capture filters, and troubleshooting recipes.
4+
5+
![Wireshark Filters](assets/preview.gif)
6+
7+
## Run locally
8+
9+
Clone the repo:
10+
11+
```bash
12+
git clone https://github.com/j86schroeder/wireshark-filters.git
13+
cd wireshark-filters
14+
```
15+
16+
Start a local web server:
17+
18+
```bash
19+
python3 -m http.server 8787
20+
```
21+
22+
Then open:
23+
24+
```text
25+
http://localhost:8787
26+
```
27+
28+
Press `Control-C` in Terminal to stop the server.
29+
30+
### macOS shortcut
31+
32+
You can also run:
33+
34+
```bash
35+
./start.command
36+
```
37+
38+
That starts the server and opens the site in your default browser.
39+
40+
## Features
41+
42+
- 200+ filters and recipes
43+
- Search, sort, filter, and paginate
44+
- Drag-and-drop column ordering
45+
- One-click copy and favorites
46+
- Add personal filters in the browser
47+
- CSV export and print view
48+
- No framework or backend
49+
50+
## Add filters
51+
52+
Permanent filters live in `data/filters.json`.
53+
54+
After editing it:
55+
56+
```bash
57+
python3 scripts/build_data.py
58+
python3 scripts/validate_filters.py
59+
```
60+
61+
The **+ Add row** button can also save personal filters locally in your browser.
62+
63+
## License
64+
65+
[MIT License](LICENSE)
66+
67+
Wireshark is a trademark of the Wireshark Foundation. This project is independent and is not affiliated with or endorsed by the Wireshark Foundation.

SECURITY.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Security
2+
3+
This is a static site with no backend, analytics, or telemetry.
4+
5+
Favorites are stored in browser `localStorage`. The site does not ingest packet captures.
6+
7+
For a security issue, use GitHub private vulnerability reporting if enabled rather than posting sensitive details in a public issue.

0 commit comments

Comments
 (0)