Gitiles
Code Review Sign In
gerrit.named-data.net / ndn-tools / e158c1f47abdf91d66869bd40a4d527c5b66c294 / . / README.md
blob: ab46e9304f353a5610f8a7c63e913ae877907789 [file] [log] [blame] [view]
Junxiao Shi6ca48812015-03-26 23:14:19 -0700[diff] [blame]1# NDN Essential Tools
2
Davide Pesaventocc02c362024-04-21 16:45:05 -0400[diff] [blame]3![Latest version](https://img.shields.io/github/v/tag/named-data/ndn-tools?label=Latest%20version)
4![Language](https://img.shields.io/badge/C%2B%2B-17-blue)
Davide Pesaventoc4343232021-08-13 23:17:05 -0400[diff] [blame]5[![CI](https://github.com/named-data/ndn-tools/actions/workflows/ci.yml/badge.svg)](https://github.com/named-data/ndn-tools/actions/workflows/ci.yml)
Davide Pesavento81c3c642024-05-08 13:40:47 -0400[diff] [blame]6[![Docker](https://github.com/named-data/ndn-tools/actions/workflows/docker.yml/badge.svg)](https://github.com/named-data/ndn-tools/actions/workflows/docker.yml)
Davide Pesaventoc4343232021-08-13 23:17:05 -0400[diff] [blame]7[![Docs](https://github.com/named-data/ndn-tools/actions/workflows/docs.yml/badge.svg)](https://github.com/named-data/ndn-tools/actions/workflows/docs.yml)
Davide Pesaventob5a57452016-09-20 19:18:25 +0200[diff] [blame]8
Davide Pesaventodb9613e2023-01-20 20:52:21 -0500[diff] [blame]9This repository contains a collection of basic tools for [Named Data Networking (NDN)](https://named-data.net/).
10The tools currently included are:
Junxiao Shi6ca48812015-03-26 23:14:19 -0700[diff] [blame]11
Davide Pesavento8ca94572025-04-20 14:52:00 -0400[diff] [blame]12* [**ndnpeek** and **ndnpoke**](tools/peek): transmit a single Interest/Data packet
13 between a consumer and a producer
14* [**ndnget**](tools/get) and [**ndnserve**](tools/serve): segmented file transfer
15 between a consumer and a producer
16* [**ndnping**](tools/ping): test reachability between two NDN nodes
17* [**ndndump**](tools/dump): capture and analyze live traffic on an NDN network
Davide Pesavento9907cc12025-04-20 23:30:06 -0400[diff] [blame]18* [**ndndissect**](tools/dissect): inspect the TLV structure of an NDN packet
Davide Pesaventodb9613e2023-01-20 20:52:21 -0500[diff] [blame]19* [**dissect-wireshark**](tools/dissect-wireshark): Wireshark extension to inspect
Davide Pesavento786a7f22019-04-14 17:18:14 -0400[diff] [blame]20 the TLV structure of NDN packets
Junxiao Shi6ca48812015-03-26 23:14:19 -0700[diff] [blame]21
Davide Pesavento786a7f22019-04-14 17:18:14 -0400[diff] [blame]22## Installation
Junxiao Shi6ca48812015-03-26 23:14:19 -0700[diff] [blame]23
Davide Pesavento786a7f22019-04-14 17:18:14 -0400[diff] [blame]24See [`INSTALL.md`](INSTALL.md) for build instructions.
25
26## Reporting bugs
27
28Please submit any bug reports or feature requests to the
29[ndn-tools issue tracker](https://redmine.named-data.net/projects/ndn-tools/issues).
30
31## Contributing
32
Davide Pesaventodb9613e2023-01-20 20:52:21 -0500[diff] [blame]33Contributions to ndn-tools are greatly appreciated and can be made through our
34[Gerrit code review site](https://gerrit.named-data.net/).
35If you are new to the NDN software community, please read our
36[Contributor's Guide](https://github.com/named-data/.github/blob/main/CONTRIBUTING.md)
37and [`README-dev.md`](README-dev.md) to get started.
Davide Pesavento786a7f22019-04-14 17:18:14 -0400[diff] [blame]38
39## License
40
Davide Pesaventodb9613e2023-01-20 20:52:21 -0500[diff] [blame]41ndn-tools is free software distributed under the GNU General Public License version 3.
42See [`COPYING.md`](COPYING.md) for details.