/termshark

A terminal UI for tshark, inspired by Wireshark

Primary LanguageGoMIT LicenseMIT

Termshark

A terminal user-interface for tshark, inspired by Wireshark.

V2.2 is out now with vim keys, packet marks, a command-line and themes! See the ChangeLog.

demo21

If you're debugging on a remote machine with a large pcap and no desire to scp it back to your desktop, termshark can help!

Features

  • Read pcap files or sniff live interfaces (where tshark is permitted)
  • Filter pcaps or live captures using Wireshark's display filters
  • Reassemble and inspect TCP and UDP flows
  • View network conversations by protocol
  • Copy ranges of packets to the clipboard from the terminal
  • Written in Golang, compiles to a single executable on each platform - downloads available for Linux, macOS, BSD variants, Android (termux) and Windows

tshark has many more features that termshark doesn't expose yet! See What's Next.

Install Packages

Termshark is pre-packaged for the following platforms: Arch Linux, Debian (unstable), FreeBSD, Homebrew, Kali Linux, NixOS, SnapCraft, Termux (Android) and Ubuntu.

Building

Termshark uses Go modules, so it's best to compile with Go 1.12 or higher. Set GO111MODULE=on then run:

go get github.com/gcla/termshark/v2/cmd/termshark

Then add ~/go/bin/ to your PATH.

For all packet analysis, termshark depends on tshark from the Wireshark project. Make sure tshark is in your PATH.

Quick Start

Inspect a local pcap:

termshark -r test.pcap

Capture ping packets on interface eth0:

termshark -i eth0 icmp

Run termshark -h for options.

Downloads

Pre-compiled executables are available via Github releases. Or download the latest build from the master branch - Build Status.

Documentation

See the termshark user guide, and my best guess at some FAQs. For a summary of updates, see the ChangeLog.

Dependencies

Termshark depends on these open-source packages:

  • tshark - command-line network protocol analyzer, part of Wireshark
  • tcell - a cell based terminal handling package, inspired by termbox
  • gowid - compositional terminal UI widgets, inspired by urwid, built on tcell

Note that tshark is a run-time dependency, and must be in your PATH for termshark to function. Version 1.10.2 or higher is required (approx 2013).

Contributors

Thanks to everyone that's contributed ports, patches and effort!


Ross Jacobs

πŸ’» πŸ› πŸ““

Hongarc

πŸ“–

Ryan Steinmetz

πŸ“¦

Nicolai SΓΈborg

πŸ“¦

Elliott Sales de Andrade

πŸ’»

Romanos

πŸ’»

Denys

πŸ›

jerry73204

πŸ“¦

Jon Knapp

πŸ“¦

Mario Harjac

πŸ“¦

Andrew Benson

πŸ›

sagis-tikal

πŸ›

punkymaniac

πŸ›

msenturk

πŸ›

Sandor SzΓΌcs

πŸ›

Dawid Dziurla

πŸ› πŸ“¦

jJit0

πŸ›

inzel

πŸ›

thejerrod

πŸ€”

gdluca

πŸ›

Patrick Winter

πŸ“¦

Robert Larsen

πŸ€” πŸ““

MinJae Kwon

πŸ›

the-c0d3r

πŸ€”

Gisle Vanem

πŸ›

hook

πŸ›

Lennart Koopmann

πŸ€”

Fernandez, ReK2

πŸ›

mazball

πŸ€”

wfailla

πŸ€”

荣怑

πŸ€”

thebyrdman-git

πŸ›

Clemens Mosig

πŸ›

Michael Rash

πŸ““

joelparker

πŸ““

Dragos Maftei

πŸ€”

Matthew Giassa

πŸ€”

Sean Abbott

πŸ“¦

Vincent Wang

πŸ€”

piping

πŸ€”

kevinhwang91

πŸ€” πŸ›

Justin Overfelt

πŸ€”

Anthony

πŸ€”

basondole

πŸ›

zoulja

πŸ›

freddii

πŸ›

Contact

License

License: MIT