{"id":14235631,"url":"https://github.com/pesos/rshark","last_synced_at":"2025-08-11T00:32:05.147Z","repository":{"id":51005684,"uuid":"282699892","full_name":"pesos/rshark","owner":"pesos","description":"Simple Packet Monitoring Tool","archived":false,"fork":false,"pushed_at":"2021-05-26T06:57:15.000Z","size":286,"stargazers_count":40,"open_issues_count":5,"forks_count":8,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-08-21T21:27:16.480Z","etag":null,"topics":["cli","networking","packet-monitoring","packets","rust"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pesos.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-07-26T17:30:33.000Z","updated_at":"2024-07-13T16:57:46.000Z","dependencies_parsed_at":"2022-09-25T00:31:35.699Z","dependency_job_id":null,"html_url":"https://github.com/pesos/rshark","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pesos%2Frshark","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pesos%2Frshark/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pesos%2Frshark/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pesos%2Frshark/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pesos","download_url":"https://codeload.github.com/pesos/rshark/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229478680,"owners_count":18079372,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","networking","packet-monitoring","packets","rust"],"created_at":"2024-08-20T21:02:10.664Z","updated_at":"2024-12-13T01:30:27.035Z","avatar_url":"https://github.com/pesos.png","language":"Rust","funding_links":[],"categories":["Rust"],"sub_categories":[],"readme":"# Rshark\n\n![CI](https://github.com/pmk21/rshark/workflows/CI/badge.svg)\n\nA terminal UI based packet monitoring tool written in Rust.\n\n![Example UI](images/example.png)\n\n## Installation\n\n**Works only on Unix-like OSes for now.**\n\n**Prerequisites**: `rust` and `cargo`.\n\n1. `git clone` this repository.\n2. `cd rshark`\n3. `cargo install --path .` should install the binary. Make sure `$HOME/.cargo/bin` is in your `$PATH` variable.\n\n## Usage\n\n```output\nUSAGE:\n    rshark [OPTIONS]\n\nFLAGS:\n    -h, --help       Prints help information\n    -V, --version    Prints version information\n\nOPTIONS:\n    -i, --interface \u003cINTERFACE\u003e    Sets network interface to capture packets on\n```\n\n**Note that since `rshark` sniffs network packets, it requires root privileges**\n\n### How to Run\n1. Find a network device to monitor. To find one using OSX:\n\n`networksetup -listallhardwareports`\n\n2. Run the binary on a device, e.g. WiFi, must run as root.\n`sudo cargo run -- -i en0`\n\n### Keyboard bindings\n\n| key | alternate | description |\n|-----|-----------|-------------|\n|\u003ckbd\u003ek\u003c/kbd\u003e | \u003ckbd\u003e↑\u003c/kbd\u003e | move cursor up |\n|\u003ckbd\u003ej\u003c/kbd\u003e | \u003ckbd\u003e↓\u003c/kbd\u003e | move cursor down |\n|\u003ckbd\u003eg\u003c/kbd\u003e |              | move cursor at begin |\n|\u003ckbd\u003eG\u003c/kbd\u003e |              | move cursor at end |\n|\u003ckbd\u003eESC\u003c/kbd\u003e | \u003ckbd\u003e←\u003c/kbd\u003e | reset cursor position |\n|\u003ckbd\u003eq\u003c/kbd\u003e | \u003ckbd\u003eCTRL\u003c/kbd\u003e+\u003ckbd\u003eC\u003c/kbd\u003e | quit program |\n|\u003ckbd\u003eJ\u003c/kbd\u003e | \u003ckbd\u003eTAB\u003c/kbd\u003e | toggle focus between the panels: list of packets or single packet information |\n\n\n## Support\n\nPlease open an issue and we'll try to help.\n\n## Roadmap\n\n* [x] Add code formatting check in CI.\n* [x] Add `clippy` checks for better and idiomatic Rust code.\n* [ ] Maybe a separate thread for running a timer, to get time of arrival of packets.\n* [ ] Use the `insta` crate for snapshot testing(or UI testing).\n* [ ] Gracefully handle errors instead of just panicking.\n* [ ] Maybe add a logging functionality for catching errors.\n\n## Contributing\n\nPlease check out the contribution guide [here](CONTRIBUTING.md).\n\n## Authors and Acknowledgement\n\nThis project is running thanks to all the contributors.\n\n## License\n\nApache License 2.0\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpesos%2Frshark","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpesos%2Frshark","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpesos%2Frshark/lists"}