Skip to content

Latest commit

 

History

History
111 lines (85 loc) · 4.61 KB

README.md

File metadata and controls

111 lines (85 loc) · 4.61 KB

Test Coverage Build Status Code Climate Go Report Card Known Vulnerabilities

español

DNS Scout is a DNS troubleshooting tool that helps you get your email to the inbox. It checks SPF, DMARC, and MX records, and it is for both pros and beginners. DNS Scout is compatible with macOS, Ubuntu, and Kali Linux.

Example DNS records Example IP records

Features

Curated Output for Clarity: DNS Scout stands out by filtering out non-essential information, presenting users with a cleaner, more focused view of the DNS data, and optimizing for clarity and relevance.

Enhanced Interactive CLI Interface: DNS Scout leverages readline to offer an advanced command-line interface that's easy to see and copy/paste

Session-based Memory Cycling DNS Scout's interactive interface has a memory cycle feature, controlled by the up and down arrow keys. It helps navigate recent lookups for the session quickly. This feature is useful when conducting multiple lookups, and you need to refer to a previous entry.

Streamlined WHOIS Lookup: DNS Scout efficiently parses domain registration data, presenting the user with concise registrar details and name servers, eliminating the clutter typically seen in raw WHOIS outputs.

Clear TXT Record Display: DNS Scout lists TXT records in an easily digestible format, making tasks like SPF or DMARC verification review more straightforward.

Registrar NS Name Servers MX Records Displays TXT Records, useful for checking domain verification, SPF settings, etc. DMARC Records PTR ASN Exact DNS data, no scrolling

Installation Guide for DNS Scout

Manual MacOS/Linux Nerd Install

Prerequisites: Go 1.21 For those who like to get their hands dirty:

  1. Download the Binary to your home folder: Download and extract the compiled binary for your operating system from the Releases page.

  2. Make It Executable: After downloading, open terminal and run:
    a. cd ~/Downloads/<unzipped-folder-name> "unzipped-folder-name" is the name of the folder created when extracting the tar file. b. sudo chmod +x dns-scout

  3. Move to PATH: Move the executable to a directory in your system's PATH.
    For example, you can move it to /usr/local/bin/ on a Unix-based system:
    a. sudo mkdir -p /usr/local/bin/
    b. sudo mv dns-scout /usr/local/bin/

  4. Get free or paid token from ipinfo.io Website and run the "setup-api-token.sh".
    a. cd ~/Downloads/<unzipped-folder-name> "unzipped-folder-name" is the name of the folder created when extracting the tar file.
    b. sudo chmod +x setup-api-token.sh
    c. ./setup-api-token.sh

  5. Run DNS Scout: Open a new terminal window and type dns-scout to start using the tool.

    For MacOS users, go to System Settings > Security & Privacy and give dns-scout permissions.
    If you have never used macOS terminal and the colors are default "Basic" Terminal>Settings>Profiles and choose "Homebrew", at least until you discover oh my zsh.

    Example IP records

That's it! You've manually installed DNS-Scout like a true nerd.

Here's a breakdown of how each method of storing the API token could be useful:

Environment Variable: Useful for users running the program in a controlled environment like a server, where setting environment variables is common practice. The /setup-api-token.sh script would be helpful for them.

Command-Line Argument: Useful for those who wish to specify different API tokens for different runs without changing environment variables. It could be useful for testing.

Stored in a File: Ideal for regular users who want to set the API token once and forget it. The token will be read from a file in the user's home directory, making it convenient for them.