README.md

WatchOut CLI Tool

WatchOut is a command-line interface (CLI) tool for linux that detects malware in files and URLs using the VirusTotal API. This tool provides a simple and efficient way to scan files and URLs for potential threats.

Features

• Scan files for malware using their hash values.
• Scan URLs for potential threats.
• Display detailed threat detection summaries.
• User-friendly command-line interface.

Requirements

• Python 3.x
• requests
• pyfiglet
• rich
• argparse
• vt

Installation

1. clone this repo:

   git clone https://github.com/Rohithgg/watchout.git
   cd watchout

2. Install the required Python packages:

   pip install -r requirement.txt

3. Make the watchout.py script executable and install it:

   chmod +x watchout.py
   sudo ./watchinstall.sh

Usage

To use the WatchOut CLI tool, open your terminal and type watchout followed by the desired options.

Options

• -h, --help: Show the help message and exit.
• -f, --file: Specify the file to scan.
• -u, --url: Specify the URL to scan.
• -k, --key: Specify the API key.

Examples

1. Scan a file:

   watchout -f <file_hash>

2. Scan a URL:

   watchout -u <url>

3. Specify the API key:

   watchout -k <api_key>

Getting Your API Key

To use the VirusTotal API, you need an API key. Follow these steps to get your API key:

1. Sign up at VirusTotal.
2. Visit your API key page to retrieve your key.

Acknowledgements

• VirusTotal for providing the API.
• Rich for the beautiful console output.
• PyFiglet for the ASCII art.

---

Note that this is under development, so use it at your own risk. lol