termshark 0.1.0

WireShark in the terminal
Documentation

termshark

GitHub License GitHub Workflow Status GitHub Release GitHub Downloads (all assets, all releases)

WireShark in the terminal. Note that this is a toy project, with majority features missing.

📥 Installation

Downloading from Releases

Navigate to the Releases page and download respective binary for your platform. Make sure to give it execute permissions.

Compiling from Source

Refer to pcap docs for requirements on dependencies.

git clone https://github.com/PRO-2684/termshark.git
cd termshark
cargo build --release
# The binary will be available at ./target/release/termshark

📖 Usage

▶️ Running TUI

sudo ./termshark capture # To capture from default device

Alternatively, you can configure with setcap, if you want to capture without root.

⌨️ Keyboard Control

  • ↑/↓ / j/k: Select previous/next packet
  • Page Up/Down: Fast scroll (10 packets at a time)
  • Home: Jump to first packet
  • End: Jump to last packet
  • w/s: Scroll packet details panel up/down
  • e/d: Scroll hex dump panel up/down
  • q or Ctrl+C: Quit the application

💡 Samples

Here's a list of sample packets for testing. All of them are taken from WireShark wiki, so feel free to visit it for more.

🎉 Credits

  • pcap for interacting with libpcap
  • argh for command line argument parsing
  • ratatui for TUI