@stacksjs/dnsx

<p align="center"><img src="https://github.com/stacksjs/dnsx/blob/main/.github/art/cover.jpg?raw=true" alt="Social Card of this repo"></p> [![npm version][npm-version-src]][npm-version-href] [![GitHub Actions][github-actions-src]][github-actions-href] [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)   # dnsx > A dependency-free & minimal DNS client. For the CLI, JavaScript & TypeScript. ## Features - 🌐 Simple, lightweight DNS client - 🔎 Query any DNS record type _(A, AAAA, MX, TXT, etc.)_ - 🔀 Multiple transport protocols _(UDP, TCP, TLS, HTTPS)_ - 🎨 Colorized output with optional JSON format - 🤖 CLI and Library Support - 0️⃣ Zero runtime dependencies <p align="center"><img src="https://github.com/stacksjs/dnsx/blob/main/.github/art/screenshot.png?raw=true" alt="Screenshot of dnsx"></p> ## Install ```bash bun install -d @stacksjs/dnsx ``` ## Get Started There are two ways of using this DNS client: _as a library or as a CLI._ ### Library Given the npm package is installed: ```ts import { DnsClient } from '@stacksjs/dnsx' // Simple query const client = new DnsClient({ domains: ['example.com'], type: 'A', nameserver: '1.1.1.1' }) const responses = await client.query() console.log(responses) // Advanced configuration const client = new DnsClient({ domains: ['example.com'], type: ['A', 'MX', 'TXT'], nameserver: '1.1.1.1', udp: true, // use UDP transport edns: 'show', // show EDNS records txid: 1234, // set specific transaction ID tweaks: ['aa', 'bufsize=4096'] // protocol tweaks }) const responses = await client.query() ``` ### CLI ```bash # Simple queries dnsx example.com # Query A record dnsx example.com MX # Query MX record dnsx example.com MX @1.1.1.1 # Use specific nameserver dnsx example.com MX @1.1.1.1 -T # Use TCP transport # Advanced usage dnsx -q example.com -t MX -n 1.1.1.1 --edns show # Show EDNS records dnsx example.com -J # JSON output dnsx example.com --short # Short output format dnsx example.com -Z bufsize=4096 # Set UDP buffer size ``` ## Configuration The DNS client can be configured using CLI options or through the library interface: ```ts // dnsx.config.ts import type { DnsOptions } from '@stacksjs/dnsx' const config: DnsOptions = { // Query options query: 'example.com', // Domain to query type: 'A', // Record type (A, AAAA, MX, etc) nameserver: '1.1.1.1', // Nameserver to query class: 'IN', // Query class (IN, CH, HS) // Protocol options edns: 'show', // EDNS mode (disable, hide, show) txid: 1234, // Transaction ID Z: ['aa', 'bufsize=4096'], // Protocol tweaks // Transport options udp: true, // Use UDP transport tcp: false, // Use TCP transport tls: false, // Use DNS-over-TLS https: false, // Use DNS-over-HTTPS // Output options short: false, // Short output format json: false, // JSON output format color: 'auto', // Color output (always, auto, never) seconds: false, // Show raw seconds time: false // Show query time } export default config ``` And all CLI options map directly to these configuration options: ```bash Usage: $ dnsx [...args] Commands: [...args] Perform DNS lookup for specified domains version Show the version of dtsx For more info, run any command with the `--help` flag: $ dnsx --help $ dnsx version --help Options: -q, --query <HOST> Host name or domain name to query -t, --type <TYPE> Type of the DNS record being queried (A, MX, NS...) -n, --nameserver <ADDR> Address of the nameserver to send packets to --class <CLASS> Network class of DNS record (IN, CH, HS) --edns <SETTING> Whether to OPT in to EDNS (disable, hide, show) --txid <NUMBER> Set transaction ID to specific value -Z <TWEAKS> Set uncommon protocol tweaks -U, --udp Use DNS over UDP (default: false) -T, --tcp Use DNS over TCP (default: false) -S, --tls Use DNS-over-TLS (default: false) -H, --https Use DNS-over-HTTPS (default: false) -1, --short Display nothing but first result (default: false) -J, --json Display output as JSON (default: false) --color <WHEN> When to colorize output (always, auto, never) --seconds Display durations in seconds (default: false) --time Print response time (default: false) --verbose Print additional debugging information (default: false) -h, --help Display this message -v, --version Display version number Examples: dnsx example.com dnsx example.com MX dnsx example.com A AAAA NS MX dnsx example.com -t MX -n 1.1.1.1 -T ``` _Then run:_ ```bash ./dnsx start ``` To learn more, head over to the [documentation](https://reverse-proxy.sh/). ## Testing ```bash bun test ``` ## Changelog Please see our [releases](https://github.com/stacksjs/stacks/releases) page for more information on what has changed recently. ## Contributing Please review the [Contributing Guide](https://github.com/stacksjs/contributing) for details. ## Community For help, discussion about best practices, or any other conversation that would benefit from being searchable: [Discussions on GitHub](https://github.com/stacksjs/stacks/discussions) For casual chit-chat with others using this package: [Join the Stacks Discord Server](https://discord.gg/stacksjs) ## Postcardware “Software that is free, but hopes for a postcard.” We love receiving postcards from around the world showing where `dnsx` is being used! We showcase them on our website too. Our address: Stacks.js, 12665 Village Ln #2306, Playa Vista, CA 90094, United States 🌎 ## Sponsors We would like to extend our thanks to the following sponsors for funding Stacks development. If you are interested in becoming a sponsor, please reach out to us. - [JetBrains](https://www.jetbrains.com/) - [The Solana Foundation](https://solana.com/) ## Credits - dig - [dog](https://github.com/ogham/dog) - [Chris Breuer](https://github.com/chrisbbreuer) - [All Contributors](../../contributors) ## License The MIT License (MIT). Please see [LICENSE](https://github.com/stacksjs/stacks/tree/main/LICENSE.md) for more information. Made with 💙  [npm-version-src]: https://img.shields.io/npm/v/@stacksjs/dnsx?style=flat-square [npm-version-href]: https://npmjs.com/package/@stacksjs/dnsx [github-actions-src]: https://img.shields.io/github/actions/workflow/status/stacksjs/dnsx/ci.yml?style=flat-square&branch=main [github-actions-href]: https://github.com/stacksjs/dnsx/actions?query=workflow%3Aci