blob: 127f9f3dbe81180388398c1471f19097d54b86a4 [file] [log] [blame] [view]
Junxiao Shi6ca48812015-03-26 23:14:19 -07001# NDN Essential Tools
2
Davide Pesaventob5a57452016-09-20 19:18:25 +02003[![Build Status](https://travis-ci.org/named-data/ndn-tools.svg?branch=master)](https://travis-ci.org/named-data/ndn-tools)
4
Junxiao Shi6ca48812015-03-26 23:14:19 -07005**ndn-tools** is a collection of essential tools for
6[Named Data Networking](http://named-data.net/).
7These tools are recommended to be installed on all NDN nodes.
8Tools in this collection include:
9
Junxiao Shi6ca48812015-03-26 23:14:19 -070010* [peek](tools/peek): transmit a single packet between a consumer and a producer
Andrea Tosatto672b9a72016-01-05 16:18:20 +010011* [chunks](tools/chunks): segmented file transfer between a consumer and producer
Junxiao Shi00aa1812015-06-27 19:27:16 -070012* [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 Afanasyev6fbb7b42015-08-10 11:53:49 -070015* [dissect-wireshark](tools/dissect-wireshark): Wireshark extension to inspect TLV structure of NDN
16 packets
Yingdi Yu0a312e52015-07-22 13:14:53 -070017* [pib](tools/pib): a service to manage the public information of keys and publish certificates
Junxiao Shi6ca48812015-03-26 23:14:19 -070018
19See [INSTALL.md](INSTALL.md) for build instructions.
20
Nick Gordon83f9a912018-01-07 19:35:19 +000021If you are new to the NDN software community, please read the
22[Contributor's Guide](https://github.com/named-data/NFD/blob/master/CONTRIBUTING.md).
Junxiao Shi6ca48812015-03-26 23:14:19 -070023Please file bug reports and feature requests on
Nick Gordon83f9a912018-01-07 19:35:19 +000024[ndn-tools Redmine site](https://redmine.named-data.net/projects/ndn-tools).
25You may contribute code on [NDN Gerrit](https://gerrit.named-data.net).
Junxiao Shi6ca48812015-03-26 23:14:19 -070026GitHub pull requests are not accepted.