Awesome Open Source
Awesome Open Source

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


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
go (14,452)Β 
golang (3,681)Β 
tui (138)Β 
pcap (53)Β 
wireshark (22)Β 

Find Open Source By Browsing 7,000 Topics Across 59 Categories

Advertising πŸ“¦Β 10
All Projects
Application Programming Interfaces πŸ“¦Β 124
Applications πŸ“¦Β 192
Artificial Intelligence πŸ“¦Β 78
Blockchain πŸ“¦Β 73
Build Tools πŸ“¦Β 113
Cloud Computing πŸ“¦Β 80
Code Quality πŸ“¦Β 28
Collaboration πŸ“¦Β 32
Command Line Interface πŸ“¦Β 49
Community πŸ“¦Β 83
Companies πŸ“¦Β 60
Compilers πŸ“¦Β 63
Computer Science πŸ“¦Β 80
Configuration Management πŸ“¦Β 42
Content Management πŸ“¦Β 175
Control Flow πŸ“¦Β 213
Data Formats πŸ“¦Β 78
Data Processing πŸ“¦Β 276
Data Storage πŸ“¦Β 135
Economics πŸ“¦Β 64
Frameworks πŸ“¦Β 215
Games πŸ“¦Β 129
Graphics πŸ“¦Β 110
Hardware πŸ“¦Β 152
Integrated Development Environments πŸ“¦Β 49
Learning Resources πŸ“¦Β 166
Legal πŸ“¦Β 29
Libraries πŸ“¦Β 129
Lists Of Projects πŸ“¦Β 22
Machine Learning πŸ“¦Β 347
Mapping πŸ“¦Β 64
Marketing πŸ“¦Β 15
Mathematics πŸ“¦Β 55
Media πŸ“¦Β 239
Messaging πŸ“¦Β 98
Networking πŸ“¦Β 315
Operating Systems πŸ“¦Β 89
Operations πŸ“¦Β 121
Package Managers πŸ“¦Β 55
Programming Languages πŸ“¦Β 245
Runtime Environments πŸ“¦Β 100
Science πŸ“¦Β 42
Security πŸ“¦Β 396
Social Media πŸ“¦Β 27
Software Architecture πŸ“¦Β 72
Software Development πŸ“¦Β 72
Software Performance πŸ“¦Β 58
Software Quality πŸ“¦Β 133
Text Editors πŸ“¦Β 49
Text Processing πŸ“¦Β 136
User Interface πŸ“¦Β 330
User Interface Components πŸ“¦Β 514
Version Control πŸ“¦Β 30
Virtualization πŸ“¦Β 71
Web Browsers πŸ“¦Β 42
Web Servers πŸ“¦Β 26
Web User Interface πŸ“¦Β 210