| Junxiao Shi | 6ca4881 | 2015-03-26 23:14:19 -0700 | [diff] [blame] | 1 | # NDN Essential Tools |
| 2 | |
| Davide Pesavento | b5a5745 | 2016-09-20 19:18:25 +0200 | [diff] [blame] | 3 | [](https://travis-ci.org/named-data/ndn-tools) |
| 4 | |
| Junxiao Shi | 6ca4881 | 2015-03-26 23:14:19 -0700 | [diff] [blame] | 5 | **ndn-tools** is a collection of essential tools for |
| 6 | [Named Data Networking](http://named-data.net/). |
| 7 | These tools are recommended to be installed on all NDN nodes. |
| 8 | Tools in this collection include: |
| 9 | |
| Junxiao Shi | 6ca4881 | 2015-03-26 23:14:19 -0700 | [diff] [blame] | 10 | * [peek](tools/peek): transmit a single packet between a consumer and a producer |
| Andrea Tosatto | 672b9a7 | 2016-01-05 16:18:20 +0100 | [diff] [blame] | 11 | * [chunks](tools/chunks): segmented file transfer between a consumer and producer |
| Junxiao Shi | 00aa181 | 2015-06-27 19:27:16 -0700 | [diff] [blame] | 12 | * [ping](tools/ping): test reachability between two nodes |
| 13 | * [dump](tools/dump): analyze traffic on wire |
| 14 | * [dissect](tools/dissect): inspect TLV structure of NDN packet format |
| Alexander Afanasyev | 6fbb7b4 | 2015-08-10 11:53:49 -0700 | [diff] [blame] | 15 | * [dissect-wireshark](tools/dissect-wireshark): Wireshark extension to inspect TLV structure of NDN |
| 16 | packets |
| Junxiao Shi | 6ca4881 | 2015-03-26 23:14:19 -0700 | [diff] [blame] | 17 | |
| 18 | See [INSTALL.md](INSTALL.md) for build instructions. |
| 19 | |
| Nick Gordon | 83f9a91 | 2018-01-07 19:35:19 +0000 | [diff] [blame] | 20 | If you are new to the NDN software community, please read the |
| 21 | [Contributor's Guide](https://github.com/named-data/NFD/blob/master/CONTRIBUTING.md). |
| Junxiao Shi | 6ca4881 | 2015-03-26 23:14:19 -0700 | [diff] [blame] | 22 | Please file bug reports and feature requests on |
| Nick Gordon | 83f9a91 | 2018-01-07 19:35:19 +0000 | [diff] [blame] | 23 | [ndn-tools Redmine site](https://redmine.named-data.net/projects/ndn-tools). |
| 24 | You may contribute code on [NDN Gerrit](https://gerrit.named-data.net). |
| Junxiao Shi | 6ca4881 | 2015-03-26 23:14:19 -0700 | [diff] [blame] | 25 | GitHub pull requests are not accepted. |