(Work in progress) Interactive tool to quickly search and run cheat sheet examples.
The main motivations for creating this project are:
- Getting hints about cli tools that are not used often enough to remember their basic use
- Quickly executing repetitive commands by caching command parameters (eg. IPs or host names)
- Searching for tools to interact with particular services and protocols (eg. listing all tools to interact/get info from dns or http servers)
- Solve CTF challenges quicker while also learning how to use the involved tools, as opposed to automated tools that just run a bunch of scripts without even asking the user
- Enhancing command line productivity in general
- Being able to automatically export command results to markdown format using a template (to do)
The only dependency of this project is Python 3. It is true that for actually running cheat sheet examples the involved tools have to be installed, but as it would be a bit too intrusive, the script will just print installed tools in green and non-installed ones in red.
There is no need for installing any extra tools. I would recommend, though, to add an alias to execute it in a simpler way:
alias eg="python3 /path/to/eg/repo/app/eg.py"
By doing this, it is possible to run eg keyword insted of python3 eg.py keyword.
$ eg -h
NAME
eg -- Interactive tool to search and run cheat-sheet examples
SYNOPSIS
eg [keyword]
EXAMPLES
# Search for tools related to dns
eg dns
# Directly access nmap examples
eg nmap
# Access the interactive app
eg
Add them to app/tools_info.json. Remember to also add some keywords to them so that they are retrieved when searching by keywords.
The examples may have parameters which will be asked for when being executed. Add parameters using double curly braces, for example:
find . -name {{keyword}}
Search for tools that match the dns keyword:
$ eg dns
Results for dns:
1) nslookup: Query Internet name servers interactively
2) dig: DNS lookup utility
3) dnsrecon: DNS Enumeration and Scanning Tool
4) dnsmap: DNS Network Mapper
Enter tool index (or enter to go back):
Now select one of the tools to list their cheat sheet examples:
Enter tool index (or enter to go back): 1
Examples for nslookup:
1 - Query A records
nslookup {{RHOST}}
-------
2 - Query NS records
nslookup -type=ns {{RHOST}}
-------
3 - Query MX records
nslookup -type=mx {{RHOST}}
-------
4 - Query all available DNS records
nslookup -type=any {{RHOST}}
-------
Enter index of the example to run (or enter to go back):
Select the example to run, set parameters and run:
Enter index of the example to run (or enter to go back): 1
nslookup {{RHOST}}
Please set parameters
RHOST: google.com
$ nslookup google.com
Server: 192.168.1.1
Address: 192.168.1.1#53
Non-authoritative answer:
Name: google.com
Address: 172.217.172.46
When searching by tool name the tool selection is done automatically:
$ eg nmap
Examples for nmap:
1 - Aggressive: Standard scripts, OS and versions detection
nmap -A {{RHOST}}
-------
2 - Scan all 65535 ports
nmap -p- {{RHOST}}
-------
Enter index of the example to run (or enter to go back):
Feel free to add new cheat sheet examples to app/tools_info.json which serves as cheat sheet db. Trying to keep command parameters names consistent is key as parameter values are cached and used as default for executing other commands during the same session.
GPL-3.0