Skip to content

Commit 3f80956

Browse files
author
Francesco Marano
committed
Add output examples in README
1 parent 6c856da commit 3f80956

File tree

2 files changed

+134
-51
lines changed

2 files changed

+134
-51
lines changed

‎README‎

Lines changed: 67 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,73 @@ YASS - Yet Another Subdomainer Software
1414
YASS is a plugin-powered search engine based subdomainer.
1515
Its goal is to give you a tool to query whatever search engine you like and parse HTML response writing *less than 10 lines of code*.
1616

17+
USAGE
18+
-------
19+
20+
usage: yass [-g] [-d] [-l {debug,info,warning,error,critical}] [-c | -nc] [-h]
21+
[-u] [-v]
22+
DOMAIN [SUBDOMAIN [SUBDOMAIN ...]]
23+
24+
positional arguments:
25+
DOMAIN the domain to search for
26+
SUBDOMAIN the list of subdomains to exclude
27+
28+
Output arguments:
29+
-g, --grepable output results in grepable format (default: False)
30+
-d, --debugging set output format to a more verbose one, for debugging
31+
purpose (default: False)
32+
-l {debug,info,warning,error,critical}, --level {debug,info,warning,error,critical}
33+
set output verbosity (default: info)
34+
-c, --color use color in the output (default: True)
35+
-nc, --no-color do not use color in the output
36+
37+
Informations:
38+
-h, --help show this help and exit
39+
-u, --usage show the usage and exit
40+
-v, --version show the framework version an exit
41+
42+
Example output
43+
--------------
44+
45+
$ yass microsoft.com
46+
47+
________________________________________________
48+
49+
YASS - Yet Another Subdomainer Software (v0.7.3)
50+
by Francesco Marano (@mrnfrancesco)
51+
________________________________________________
52+
53+
54+
[INFO ] Collecting subdomains with Aol
55+
[INFO ] (1/1) www.catalog.update.microsoft.com
56+
[INFO ] (2/2) partner.microsoft.com
57+
[INFO ] (3/3) docs.microsoft.com
58+
[INFO ] (4/4) account.microsoft.com
59+
[...]
60+
[INFO ] (64/64) techcommunity.microsoft.com
61+
[INFO ] Collecting subdomains with Ask
62+
[INFO ] (1/65) imaginecup.microsoft.com
63+
[INFO ] (2/66) office.microsoft.com
64+
[INFO ] (3/67) customers.microsoft.com
65+
[INFO ] (4/68) privacy.microsoft.com
66+
[INFO ] (5/69) grv.microsoft.com
67+
[INFO ] (6/70) channel9.microsoft.com
68+
[INFO ] (7/71) datamigration.microsoft.com
69+
[INFO ] (8/72) edusupport.microsoft.com
70+
[INFO ] (9/73) forms.microsoft.com
71+
[INFO ] (10/74) visualstudiogallery.msdn.microsoft.com
72+
[INFO ] Collecting subdomains with Bing
73+
[INFO ] Collecting subdomains with StartPage
74+
[INFO ] Collecting subdomains with WebCrawler
75+
[INFO ] Collecting subdomains with Yahoo
76+
Collected 74 subdomains
77+
academy.microsoft.com, account.microsoft.com, admin.manage.microsoft.com, admin.powerplatform.microsoft.com, answers.microsoft.com, apportal.microsoft.com, appsource.microsoft.com, azure.microsoft.com, bingads.microsoft.com, businessaccount.microsoft.com, businesscenter.mbs.microsoft.com, careers.microsoft.com, channel9.microsoft.com, client.dtmnebula.microsoft.com, cmat.tools.cp.microsoft.com, cmt3.research.microsoft.com, customers.microsoft.com, datamigration.microsoft.com, demos.microsoft.com, devblogs.microsoft.com, developer.microsoft.com, docs.microsoft.com, dotnet.microsoft.com, dynamics.microsoft.com, education.microsoft.com, edusupport.microsoft.com, einvoice.microsoft.com, events.microsoft.com, expertzone.microsoft.com, findtime.microsoft.com, flow.microsoft.com, forms.microsoft.com, formspro.microsoft.com, gallery.technet.microsoft.com, grv.microsoft.com, home.microsoft.com, imaginecup.microsoft.com, mail.exchange.microsoft.com, mbs.microsoft.com, mbspartner.microsoft.com, military.microsoft.com, mla.microsoft.com, mvp.microsoft.com, myinspire.microsoft.com, myprofile.microsoft.com, news.microsoft.com, nonprofit.microsoft.com, office.microsoft.com, partner.microsoft.com, partneruniversity.microsoft.com, paymentcentral.microsoft.com, plmt.microsoft.com, powerapps.microsoft.com, powerbi.microsoft.com, privacy.microsoft.com, referencesource.microsoft.com, register.ignite.microsoft.com, secure.bingads.microsoft.com, servicedesk.microsoft.com, serviceshub.microsoft.com, social.technet.microsoft.com, support.microsoft.com, teams.microsoft.com, techcommunity.microsoft.com, testconnectivity.microsoft.com, todo.microsoft.com, update.microsoft.com, visualstudio.microsoft.com, visualstudiogallery.msdn.microsoft.com, whiteboard.microsoft.com, windowsupdate.microsoft.com, www.catalog.update.microsoft.com, www.commerce.microsoft.com, www.microsoft.com
78+
79+
Yass can also be used in scripts with the `-g/--grepable` option:
80+
81+
$ yass -g microsoft.com
82+
academy.microsoft.com|account.microsoft.com|admin.manage.microsoft.com|admin.powerplatform.microsoft.com|answers.microsoft.com|apportal.microsoft.com|appsource.microsoft.com|azure.microsoft.com|bingads.microsoft.com|businessaccount.microsoft.com|businesscenter.mbs.microsoft.com|careers.microsoft.com|channel9.microsoft.com|client.dtmnebula.microsoft.com|cmat.tools.cp.microsoft.com|cmt3.research.microsoft.com|customers.microsoft.com|datamigration.microsoft.com|demos.microsoft.com|devblogs.microsoft.com|developer.microsoft.com|docs.microsoft.com|dotnet.microsoft.com|dynamics.microsoft.com|education.microsoft.com|edusupport.microsoft.com|einvoice.microsoft.com|events.microsoft.com|expertzone.microsoft.com|findtime.microsoft.com|flow.microsoft.com|formspro.microsoft.com|gallery.technet.microsoft.com|grv.microsoft.com|home.microsoft.com|imaginecup.microsoft.com|mail.exchange.microsoft.com|mbs.microsoft.com|mbspartner.microsoft.com|military.microsoft.com|mla.microsoft.com|mvp.microsoft.com|myinspire.microsoft.com|myorder.microsoft.com|myprofile.microsoft.com|news.microsoft.com|nonprofit.microsoft.com|office.microsoft.com|partner.microsoft.com|partneruniversity.microsoft.com|paymentcentral.microsoft.com|plmt.microsoft.com|powerapps.microsoft.com|powerbi.microsoft.com|privacy.microsoft.com|referencesource.microsoft.com|register.ignite.microsoft.com|secure.bingads.microsoft.com|servicedesk.microsoft.com|serviceshub.microsoft.com|social.technet.microsoft.com|support.microsoft.com|teams.microsoft.com|techcommunity.microsoft.com|testconnectivity.microsoft.com|todo.microsoft.com|update.microsoft.com|visualstudio.microsoft.com|visualstudiogallery.msdn.microsoft.com|whiteboard.microsoft.com|windowsupdate.microsoft.com|www.catalog.update.microsoft.com|www.commerce.microsoft.com|www.microsoft.com
83+
1784
YASS Plugins
1885
------------
1986
YASS comes with some pre-built plugins:
@@ -64,29 +131,3 @@ To install YASS and its requirements::
64131
git clone https://github.com/mrnfrancesco/yass.git # or download and unzip release archive
65132
cd yass
66133
./setup.py install
67-
68-
69-
USAGE
70-
-------
71-
72-
usage: yass [-g] [-d] [-l {debug,info,warning,error,critical}] [-c | -nc] [-h]
73-
[-u] [-v]
74-
DOMAIN [SUBDOMAIN [SUBDOMAIN ...]]
75-
76-
positional arguments:
77-
DOMAIN the domain to search for
78-
SUBDOMAIN the list of subdomains to exclude
79-
80-
Output arguments:
81-
-g, --grepable output results in grepable format (default: False)
82-
-d, --debugging set output format to a more verbose one, for debugging
83-
purpose (default: False)
84-
-l {debug,info,warning,error,critical}, --level {debug,info,warning,error,critical}
85-
set output verbosity (default: info)
86-
-c, --color use color in the output (default: True)
87-
-nc, --no-color do not use color in the output
88-
89-
Informations:
90-
-h, --help show this help and exit
91-
-u, --usage show the usage and exit
92-
-v, --version show the framework version an exit

‎README.md‎

Lines changed: 67 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,72 @@
77
YASS is a plugin-powered search engine based subdomainer.
88
Its goal is to give you a tool to query whatever search engine you like and parse HTML response writing *less than 10 lines of code*.
99

10+
## USAGE
11+
12+
usage: yass [-g] [-d] [-l {debug,info,warning,error,critical}] [-c | -nc] [-h]
13+
[-u] [-v]
14+
DOMAIN [SUBDOMAIN [SUBDOMAIN ...]]
15+
16+
positional arguments:
17+
DOMAIN the domain to search for
18+
SUBDOMAIN the list of subdomains to exclude
19+
20+
Output arguments:
21+
-g, --grepable output results in grepable format (default: False)
22+
-d, --debugging set output format to a more verbose one, for debugging
23+
purpose (default: False)
24+
-l {debug,info,warning,error,critical}, --level {debug,info,warning,error,critical}
25+
set output verbosity (default: info)
26+
-c, --color use color in the output (default: True)
27+
-nc, --no-color do not use color in the output
28+
29+
Informations:
30+
-h, --help show this help and exit
31+
-u, --usage show the usage and exit
32+
-v, --version show the framework version an exit
33+
34+
35+
## Example output
36+
37+
$ yass microsoft.com
38+
39+
________________________________________________
40+
41+
YASS - Yet Another Subdomainer Software (v0.7.3)
42+
by Francesco Marano (@mrnfrancesco)
43+
________________________________________________
44+
45+
46+
[INFO ] Collecting subdomains with Aol
47+
[INFO ] (1/1) www.catalog.update.microsoft.com
48+
[INFO ] (2/2) partner.microsoft.com
49+
[INFO ] (3/3) docs.microsoft.com
50+
[INFO ] (4/4) account.microsoft.com
51+
[...]
52+
[INFO ] (64/64) techcommunity.microsoft.com
53+
[INFO ] Collecting subdomains with Ask
54+
[INFO ] (1/65) imaginecup.microsoft.com
55+
[INFO ] (2/66) office.microsoft.com
56+
[INFO ] (3/67) customers.microsoft.com
57+
[INFO ] (4/68) privacy.microsoft.com
58+
[INFO ] (5/69) grv.microsoft.com
59+
[INFO ] (6/70) channel9.microsoft.com
60+
[INFO ] (7/71) datamigration.microsoft.com
61+
[INFO ] (8/72) edusupport.microsoft.com
62+
[INFO ] (9/73) forms.microsoft.com
63+
[INFO ] (10/74) visualstudiogallery.msdn.microsoft.com
64+
[INFO ] Collecting subdomains with Bing
65+
[INFO ] Collecting subdomains with StartPage
66+
[INFO ] Collecting subdomains with WebCrawler
67+
[INFO ] Collecting subdomains with Yahoo
68+
Collected 74 subdomains
69+
academy.microsoft.com, account.microsoft.com, admin.manage.microsoft.com, admin.powerplatform.microsoft.com, answers.microsoft.com, apportal.microsoft.com, appsource.microsoft.com, azure.microsoft.com, bingads.microsoft.com, businessaccount.microsoft.com, businesscenter.mbs.microsoft.com, careers.microsoft.com, channel9.microsoft.com, client.dtmnebula.microsoft.com, cmat.tools.cp.microsoft.com, cmt3.research.microsoft.com, customers.microsoft.com, datamigration.microsoft.com, demos.microsoft.com, devblogs.microsoft.com, developer.microsoft.com, docs.microsoft.com, dotnet.microsoft.com, dynamics.microsoft.com, education.microsoft.com, edusupport.microsoft.com, einvoice.microsoft.com, events.microsoft.com, expertzone.microsoft.com, findtime.microsoft.com, flow.microsoft.com, forms.microsoft.com, formspro.microsoft.com, gallery.technet.microsoft.com, grv.microsoft.com, home.microsoft.com, imaginecup.microsoft.com, mail.exchange.microsoft.com, mbs.microsoft.com, mbspartner.microsoft.com, military.microsoft.com, mla.microsoft.com, mvp.microsoft.com, myinspire.microsoft.com, myprofile.microsoft.com, news.microsoft.com, nonprofit.microsoft.com, office.microsoft.com, partner.microsoft.com, partneruniversity.microsoft.com, paymentcentral.microsoft.com, plmt.microsoft.com, powerapps.microsoft.com, powerbi.microsoft.com, privacy.microsoft.com, referencesource.microsoft.com, register.ignite.microsoft.com, secure.bingads.microsoft.com, servicedesk.microsoft.com, serviceshub.microsoft.com, social.technet.microsoft.com, support.microsoft.com, teams.microsoft.com, techcommunity.microsoft.com, testconnectivity.microsoft.com, todo.microsoft.com, update.microsoft.com, visualstudio.microsoft.com, visualstudiogallery.msdn.microsoft.com, whiteboard.microsoft.com, windowsupdate.microsoft.com, www.catalog.update.microsoft.com, www.commerce.microsoft.com, www.microsoft.com
70+
71+
Yass can also be used in scripts with the `-g/--grepable` option:
72+
73+
$ yass -g microsoft.com
74+
academy.microsoft.com|account.microsoft.com|admin.manage.microsoft.com|admin.powerplatform.microsoft.com|answers.microsoft.com|apportal.microsoft.com|appsource.microsoft.com|azure.microsoft.com|bingads.microsoft.com|businessaccount.microsoft.com|businesscenter.mbs.microsoft.com|careers.microsoft.com|channel9.microsoft.com|client.dtmnebula.microsoft.com|cmat.tools.cp.microsoft.com|cmt3.research.microsoft.com|customers.microsoft.com|datamigration.microsoft.com|demos.microsoft.com|devblogs.microsoft.com|developer.microsoft.com|docs.microsoft.com|dotnet.microsoft.com|dynamics.microsoft.com|education.microsoft.com|edusupport.microsoft.com|einvoice.microsoft.com|events.microsoft.com|expertzone.microsoft.com|findtime.microsoft.com|flow.microsoft.com|formspro.microsoft.com|gallery.technet.microsoft.com|grv.microsoft.com|home.microsoft.com|imaginecup.microsoft.com|mail.exchange.microsoft.com|mbs.microsoft.com|mbspartner.microsoft.com|military.microsoft.com|mla.microsoft.com|mvp.microsoft.com|myinspire.microsoft.com|myorder.microsoft.com|myprofile.microsoft.com|news.microsoft.com|nonprofit.microsoft.com|office.microsoft.com|partner.microsoft.com|partneruniversity.microsoft.com|paymentcentral.microsoft.com|plmt.microsoft.com|powerapps.microsoft.com|powerbi.microsoft.com|privacy.microsoft.com|referencesource.microsoft.com|register.ignite.microsoft.com|secure.bingads.microsoft.com|servicedesk.microsoft.com|serviceshub.microsoft.com|social.technet.microsoft.com|support.microsoft.com|teams.microsoft.com|techcommunity.microsoft.com|testconnectivity.microsoft.com|todo.microsoft.com|update.microsoft.com|visualstudio.microsoft.com|visualstudiogallery.msdn.microsoft.com|whiteboard.microsoft.com|windowsupdate.microsoft.com|www.catalog.update.microsoft.com|www.commerce.microsoft.com|www.microsoft.com
75+
1076
#### YASS Plugins
1177
YASS comes with some pre-built plugins:
1278

@@ -53,28 +119,4 @@ To install YASS and its requirements:
53119

54120
git clone https://github.com/mrnfrancesco/yass.git # or download and unzip release archive
55121
cd yass
56-
./setup.py install
57-
58-
#### USAGE
59-
60-
usage: yass [-g] [-d] [-l {debug,info,warning,error,critical}] [-c | -nc] [-h]
61-
[-u] [-v]
62-
DOMAIN [SUBDOMAIN [SUBDOMAIN ...]]
63-
64-
positional arguments:
65-
DOMAIN the domain to search for
66-
SUBDOMAIN the list of subdomains to exclude
67-
68-
Output arguments:
69-
-g, --grepable output results in grepable format (default: False)
70-
-d, --debugging set output format to a more verbose one, for debugging
71-
purpose (default: False)
72-
-l {debug,info,warning,error,critical}, --level {debug,info,warning,error,critical}
73-
set output verbosity (default: info)
74-
-c, --color use color in the output (default: True)
75-
-nc, --no-color do not use color in the output
76-
77-
Informations:
78-
-h, --help show this help and exit
79-
-u, --usage show the usage and exit
80-
-v, --version show the framework version an exit
122+
./setup.py install

0 commit comments

Comments
 (0)