Skip to content

Commit d9126b3

Browse files
Update README
1 parent acbd6cd commit d9126b3

File tree

1 file changed

+53
-13
lines changed

1 file changed

+53
-13
lines changed

README.md

Lines changed: 53 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,14 @@
88

99
# IPScope
1010

11-
A CLI tool written in pure Go for IP lookup and subdomain discovery. Designed for security researchers and network administrators to resolve IP addresses for TLDs and subdomains. Includes support for some reverse proxy and WAF detection.
11+
A CLI tool written in pure Go for subdomain discovery and IP lookup. Designed for security researchers and network administrators to resolve IP addresses for TLDs and subdomains. Includes support for some reverse proxy and WAF detection.
1212

13-
IPScope was written as a capable, no-fuss alternative to more complex CLI tools commonly used for subdomain discovery and active DNS resolution. IPScope features a simple CLI that only requires one command-line argument, the target URL, while maintaining a powerful backend and optional command-line arguments for further customization. Since it's written in Go, there's no need to hunt down outdated or obscure Python / Ruby dependencies, and since it's written with ease of use in mind, there's no need to figure out complex command-line arguments -- **IPScope just works**.
13+
IPScope was written as a capable, no-fuss alternative to more complex CLI tools commonly used for subdomain discovery and active DNS resolution. IPScope features a simple CLI that only requires one command-line argument, the target URL, while maintaining a powerful backend and optional command-line arguments for further customization. Since it's written in Go, there's no need to hunt down outdated or obscure Python / Ruby / Perl dependencies (we've all been there), and since it's written with ease of use in mind, there's no need to figure out complex command-line arguments -- **IPScope just works**.
1414

1515
### Usage Instructions:
1616
Of course, don't run IPScope on domains you don't have permission to probe.
1717

18-
- Example Usage:
19-
- `./ipscope.bin -url example.org`
18+
- `./ipscope.bin -url example.org`
2019
```
2120
_
2221
____ _ _ ____| | ___ ____ _____
@@ -25,25 +24,66 @@ Of course, don't run IPScope on domains you don't have permission to probe.
2524
\____)\__ |\____)\_)___/|_| |_|_____)
2625
(____/
2726
27+
Cyclone's IPScope v0.2.4; 2025-01-08
28+
https://github.com/cyclone-github/ipscope
29+
2830
Processing URL: example.org using DNS: 1.1.1.1
2931
3032
TLD example.org 93.184.215.14 AS15133 Edgecast Inc. Dźwirzyno, West Pomerania, PL (Reverse Proxy or WAF Detected)
3133
TLD www.example.org 93.184.215.14 AS15133 Edgecast Inc. Dźwirzyno, West Pomerania, PL (Reverse Proxy or WAF Detected)
3234
```
33-
- `./ipscope.bin -url example.org -sub subdomains.txt -dns 8.8.8.8`
35+
- `./ipscope.bin -url example.org -sub subdomains.txt -dns 8.8.8.8 -json`
36+
```
37+
_
38+
____ _ _ ____| | ___ ____ _____
39+
/ ___) | | |/ ___) |/ _ \| _ \| ___ |
40+
( (___| |_| ( (___| | |_| | | | | ____|
41+
\____)\__ |\____)\_)___/|_| |_|_____)
42+
(____/
43+
44+
Cyclone's IPScope v0.2.4; 2025-01-08
45+
https://github.com/cyclone-github/ipscope
46+
47+
Processing URL: example.org using DNS: 8.8.8.8
48+
49+
{"label":"TLD","domain":"www.example.org","ip":"93.184.215.14","asn":"AS15133 Edgecast Inc.","city":"Dźwirzyno","region":"West Pomerania","country":"PL","proxy":true}
50+
{"label":"TLD","domain":"example.org","ip":"93.184.215.14","asn":"AS15133 Edgecast Inc.","city":"Dźwirzyno","region":"West Pomerania","country":"PL","proxy":true}
51+
```
52+
- `./ipscope.bin -url example.org -sub subdomains.txt -dns 8.8.8.8 -json -o output.txt`
53+
```
54+
_
55+
____ _ _ ____| | ___ ____ _____
56+
/ ___) | | |/ ___) |/ _ \| _ \| ___ |
57+
( (___| |_| ( (___| | |_| | | | | ____|
58+
\____)\__ |\____)\_)___/|_| |_|_____)
59+
(____/
60+
61+
Cyclone's IPScope v0.2.4; 2025-01-08
62+
https://github.com/cyclone-github/ipscope
63+
64+
Processing URL: example.org using DNS: 8.8.8.8
3465
35-
The `-dns` flag is useful for testing how a domain resolves with specific DNS servers, such as 1.1.1.1, 8.8.8.8, or DNS based filtering such as Cloudflare 1.1.1.3 or OpenDNS 208.67.222.222. It’s also great for testing locally hosted DNS servers like Pi-hole or pfSense.
66+
Output redirected to file: output.txt
67+
```
68+
### Supported flags:
69+
- `-url {foobar.com} (url to scan)`
70+
- `-sub {subdirectory_file} (defaults to built-in list)`
71+
- `-dns {dns_server} (defaults to 1.1.1.1)`
72+
- `-json (outputs stdout to json format)`
73+
- `-o {output_file} (redirects stdout to file)`
74+
- `-help (prints usage instructions)`
75+
- `-version (prints version info)`
76+
77+
The `-dns` flag is useful for testing how a domain resolves with a specific DNS server, such as 1.1.1.1, 8.8.8.8, or DNS based filtering such as Cloudflare 1.1.1.3 or OpenDNS 208.67.222.222. It’s also great for testing locally hosted DNS servers like Pi-hole or pfSense.
3678

3779
The tool can also be used with a custom subdomain list via the `-sub` flag to verify if known subdomains are resolving correctly through services like Cloudflare, or to check if they are leaking their host IP.
3880

81+
The `-json` flag will format stdout to json, while the `-o` flag will redirect stdout to file.
82+
3983
If neither the `-dns` nor `-sub` flags are given, the tool defaults to 1.1.1.1 and a built-in list of the top 10k common subdomains.
4084

41-
- Supported flags:
42-
- `-url example.org (required)`
43-
- `-sub subdomain.txt (optional, defaults to built-in list)`
44-
- `-dns 8.8.8.8 (optional, defaults to 1.1.1.1)`
45-
- `-help (usage instructions)`
46-
- `-version (version info)`
85+
IPScope output is:
86+
`label` `domain` `ip` `asn` `city` `region` `country` `proxy`
4787

4888
### Compile from source:
4989
- If you want the latest features, compiling from source is the best option since the release version may run several revisions behind the source code.
@@ -55,7 +95,7 @@ If neither the `-dns` nor `-sub` flags are given, the tool defaults to 1.1.1.1 a
5595
- `go build -ldflags="-s -w" .`
5696
- Compile from source code how-to:
5797
- https://github.com/cyclone-github/scripts/blob/main/intro_to_go.txt
58-
### Change Log:
98+
### Changelog:
5999
- https://github.com/cyclone-github/ipscope/blob/main/CHANGELOG.md
60100

61101
### Antivirus False Positives:

0 commit comments

Comments
 (0)