Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
careyjames authored Oct 10, 2023
1 parent 07067ee commit 4889bd7
Showing 1 changed file with 7 additions and 23 deletions.
30 changes: 7 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,15 @@ Registrar, NS, MX, SPF, DMARC, and PTR for easy DNS reconnaissance and troublesh
more focused view of the DNS data, and optimizing for clarity and relevance.

**Enhanced Interactive CLI Interface:**
DNS Scout leverages ```prompt_toolkit``` to offer an advanced command-line 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 domain lookups for the session quickly.
This feature is useful when conducting multiple lookups, and you need to refer to a previous entry.
The memory is session-based, which means it clears once you exit DNS Scout, maintaining your privacy and a clean slate for your next session.


**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.
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,
Expand All @@ -32,34 +31,19 @@ The memory is session-based, which means it clears once you exit DNS Scout, main
**MX Records**
**Displays TXT Records**, useful for checking domain verification, SPF settings, etc.
**DMARC Records**
**PTR**
**PTR**
**ASN**
**Exact DNS data, no scrolling**

### Installation Guide for DNS Scout
Prerequisites: Python 3.x
Prerequisites: Go 1.21

1. Clone the Repository:
If you have Git installed, run: ```git clone https://github.com/careyjames/dns-scout.git```
If you don't have Git, download the repository as a zip file and extract it in your home folder.

2. Navigate to the Directory:
```cd ~/DNS-Scout```

3. Install Required Python Libraries:
Run the following commands to install the necessary Python libraries:
```pip install dnspython whois prompt-toolkit colorama```

-```colorama``` to print colored output to the terminal.
-```prompt_toolkit``` to enhance the input prompt,
allowing for functionalities like copy/paste and keeping a history of entered domains.


#### **Usage:**
Navigate to the directory where ```dns-scout.py``` is located.
```cd ~/DNS-Scout/```
Then run: ```python3 dns-scout.py```
Follow the on-screen prompts to input a domain and retrieve its information.
OR
Add this line: ```alias dns='python3 ~/DNS-Scout/dns-scout.py``` in your ```.zshrc``` file for a cool shortcut.
Then, you can simply type "dns" in terminal to launch.


0 comments on commit 4889bd7

Please sign in to comment.