From 1e2a498a98c55f80e7adae38c1e4268f4afe8ac2 Mon Sep 17 00:00:00 2001 From: Takumasa Sakao Date: Tue, 13 Feb 2018 00:20:09 +0900 Subject: [PATCH] :+1: Add README --- README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..2cc2a9d --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ +tcpterm +=== + +tcpterm visualize packets in TUI. + +This project aims tcpdump for human. + +Demo +--- + +[![asciicast](https://asciinema.org/a/td3DA8LH04XYhxGPirJvsEI4V.png)](https://asciinema.org/a/td3DA8LH04XYhxGPirJvsEI4V) + +Install +--- + +``` +$ go get github.com/sachaos/tcpterm +``` + +Usage +--- + +``` +$ tcpterm -h +NAME: + tcpterm - tcpdump for human + +USAGE: + tcpterm [global options] command [command options] [arguments...] + +VERSION: + 0.0.1 + +COMMANDS: + help, h Shows a list of commands or help for one command + +GLOBAL OPTIONS: + --interface value, -i value If unspecified, use lowest numbered interface. + --help, -h show help + --version, -v print the version +``` + +TODO +--- + +* Optimize packets list view. +* Fix SIGSEGV bug. +* Improve detail view, and dump view.