dig.js/README.md

81 lines
1.5 KiB
Markdown

dig.js
======
Create and capture DNS and mDNS query and response packets to disk as binary and/or JSON.
Options are similar to the Unix `dig` command.
Install with git
-------
```bash
# Install the latest of v1.x
npm install -g 'git+https://git@git.daplie.com/Daplie/dig.js.git#v1'
```
```bash
# Install exactly v1.0.0
npm install -g 'git+https://git@git.daplie.com/Daplie/dig.js.git#v1.0.0'
```
Install without git
-------
Don't have git? Well, you can also bow down to the gods of the centralized, monopolized, concentrated, *dictator*net
(as we like to call it here at Daplie Labs), if that's how you roll:
```bash
npm install -g dig.js
```
Usage
-----
### Format
```bash
dig.js [TYPE] <domainname>
```
### Example
```bash
dig.js daplie.com
```
### mDNS Browser Example
This is pretty much an mDNS browser
```bash
dig.js --mdns _services._dns-sd._udp.local
```
Really the `--mdns` option is just an alias for setting all of these options as the default:
```bash
dig.js -p 5353 @224.0.0.251 PTR _services._dns-sd._udp.local
```
### Moar Examples
```bash
dig.js A daplie.com
dig.js -t A daplie.com
dig.js @8.8.8.8 A daplie.com
```
Options
-------
```
--debug
--mdns
--output <path/to/file> write query and response(s) to disk with this path prefix (ex: ./samples/dns)
-t <type> (superfluous) default ANY (mdns default: PTR)
-c <class> default IN
-p <port> default 53 (mdns default: 5353) (listener is random for DNS and 5353 for mDNS)
-q <query> (superfluous) required (ex: daplie.com)
```