Skip to content

vatsalyatandon/rshark

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Rshark

CI

A terminal UI based packet monitoring tool written in Rust.

Example UI

Installation

Works only on Linux for now.

Prerequisites: rust and cargo.

  1. git clone this repository.
  2. cd rshark
  3. cargo install should install the binary. Make sure $HOME/.cargo/bin is in your $PATH variable.

Usage

USAGE:
    rshark [OPTIONS]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -i, --interface <INTERFACE>    Sets network interface to capture packets on

Note that since rshark sniffs network packets, it requires root privileges

Support

Please open an issue and we'll try to help.

Roadmap

  • Add code formatting check in CI.
  • Add clippy checks for better and idiomatic Rust code.
  • Maybe a separate thread for running a timer, to get time of arrival of packets.
  • Use the insta crate for snapshot testing(or UI testing).
  • Gracefully handle errors instead of just panicking.
  • Maybe add a logging functionality for catching errors.

Contributing

Please check out the contribution guide here.

Authors and Acknowledgement

This project is running thanks to all the contributors.

License

Apache License 2.0

About

Simple Packet Monitoring Tool

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Rust 100.0%