coolaj86
/
dns-suite.js
1
0
Fork 0
Code Issues 1 Pull Requests 1 Releases Activity

add new bins to README

This commit is contained in:
AJ ONeal 2017-09-28 13:30:03 -06:00
parent a287abb991
commit d66624df8e
1 changed files with 10 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -92,27 +92,24 @@ Usage
* CLI
* API
**CLI**
### CLI Usage
You can work directly from `node_modules/dns-suite`:
When installed globally you can use these commands:
```bash
pushd node_modules/dns-suite/
```
dns-parse.js </path/to/packet.dns.bin> [out.json] # parses a saved DNS packet to JSON
dns-pack.js </path/to/packet.dns.json> [out.bin] # packs a JSON DNS packet to binary
dns-test.js </path/to/packet.dns(.json|.bin)> # convert a packet back and forth to test reciprocity of the packer and parser
mdns-capture.js <prefixname> [startnum] # listen and save all mDNS packets, numbering by sequence of arrival
```
Parsing a saved packet
You can also access them directly from `node_modules/dns-suite` in a project:
```bash
# example
# node bin/dns-parse.js </path/to/packet.dns.bin>
node bin/dns-parse.js samples/a-0.mdns.bin
node node_modules/dns-suite/bin/dns-parse.js node_modules/dns-suite/samples/a-0.mdns.bin
```
You can also parse a saved packet from the `native-dns-packet` directory.
these test packets have the binary for each record type and what it's parsed output
should be.
**Library**
### Library API
* `DNSPacket.parse(nodeOrArrayBuffer)` returns json (as shown above)
* `DNSPacket.pack(packet)` returns ArrayBuffer (browser and node)