diff --git a/README.md b/README.md index ac90748..a047862 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,50 @@ -# MOSINT +

+ mosint +
+

- + + +

-## What is the MOSINT +

+ Features • + Installation • + Services • + Usage • + Config +

+ +Mosint is an automated email osint tool written in Go that allows you investigate for target emails in a fast and efficient manner. It consolidates numerous services, enabling security researchers to swiftly access a wealth of information. -MOSINT is a fastest OSINT Tool for emails. It helps you gather information about the target email. +# Features -#### Features: :eyes: +

+ mosint +
+

-* Email validation -* Check social accounts -* Check data breaches and password leaks -* Find related emails and domains -* Scan Pastebin Dumps -* Google Search -* DNS/IP Lookup + - Fast and simple email-based scanning + - Optimized for ease of use and **lightweight** on resources + - Email verification and validation + - Checking **Social Media** Accounts + - Checking **data breaches** and **password leaks** + - Finding **related** emails and domains + - Scanning **pastebin dumps** + - Google Search + - DNS/IP Lookup + - Output to **JSON** file + - Print coffee with `--coffee` flag! +# Installation + +```sh +go install -v github.com/alpkeskin/mosint/v3/cmd/mosint@latest +``` -## Services (APIs): +# Services | Service | Function | Status | | :--- | :--- | :--- | @@ -30,31 +55,24 @@ MOSINT is a fastest OSINT Tool for emails. It helps you gather information about | [psbdmp.ws](https://psbdmp.ws/) - Public | Pastebin Dumps | :white\_check\_mark: :key: | | [Intelligence X](https://intelx.io/)| Password Leaks | :white\_check\_mark: :key: | | [BreachDirectory](https://breachdirectory.org/)| Password Leaks | :white\_check\_mark: :key: | +| [HaveIBeenPwned](https://haveibeenpwned.com/)| Password Leaks | :white\_check\_mark: :key: | :key: API key required -#### If you want to use mosint with full features, set your API keys: +# Configuration file - ``` - mosint set hunter - mosint set emailrep - mosint set intelx - mosint set psbdmp - mosint set breachdirectory - ``` +Mosint supports config file as default located at `$HOME/.mosint.yaml`. It allows you to define API keys for services. -## Installation: -``` -go install -v github.com/alpkeskin/mosint@latest -``` +**You must set the config file for mosint to run! To specify a configuration file located in a directory other than the home directory, you can use the `--config` flag.** -## Usage: +# Usage: ``` mosint example@email.com ``` -## Screen : +Call the help (`-h`) flag for more information on usage. -[![mosint](https://asciinema.org/a/529726.svg)](https://asciinema.org/a/529726) +## Screen : +[![mosint](https://asciinema.org/a/609038.svg)](https://asciinema.org/a/609038)