mirror of
https://github.com/soxoj/maigret.git
synced 2026-05-07 06:24:35 +00:00
Readme update
This commit is contained in:
@@ -1,40 +1,55 @@
|
|||||||
# Maigret
|
# Maigret
|
||||||
|
|
||||||

|
|
||||||

|
|
||||||
[](https://gitter.im/maigret-osint/community)
|
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="./static/maigret.png" />
|
<p align="center">
|
||||||
|
<a href="https://pypi.org/project/maigret/">
|
||||||
|
<img alt="PyPI" src="https://img.shields.io/pypi/v/maigret?style=flat-square">
|
||||||
|
</a>
|
||||||
|
<a href="https://pypi.org/project/maigret/">
|
||||||
|
<img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dw/maigret?style=flat-square">
|
||||||
|
</a>
|
||||||
|
<a href="https://gitter.im/maigret-osint/community">
|
||||||
|
<img alt="Chat - Gitter" src="./static/chat_gitter.svg" />
|
||||||
|
</a>
|
||||||
|
<a href="https://twitter.com/intent/follow?screen_name=sox0j">
|
||||||
|
<img src="https://img.shields.io/twitter/follow/sox0j?label=Follow%20sox0j&style=social&color=blue" alt="Follow @sox0j" />
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
<p align="center">
|
||||||
|
<img src="./static/maigret.png" height="200"/>
|
||||||
|
</p>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<i>The Commissioner Jules Maigret is a fictional French police detective, created by Georges Simenon. His investigation method is based on understanding the personality of different people and their interactions.</i>
|
<i>The Commissioner Jules Maigret is a fictional French police detective, created by Georges Simenon. His investigation method is based on understanding the personality of different people and their interactions.</i>
|
||||||
|
|
||||||
## About
|
## About
|
||||||
|
|
||||||
Purpose of Maigret - **collect a dossier on a person by username only**, checking for accounts on a huge number of sites.
|
**Maigret** collect a dossier on a person **by username only**, checking for accounts on a huge number of sites and gathering all the available information from web pages. Maigret is an easy-to-use and power fork of [Sherlock](https://github.com/sherlock-project/sherlock).
|
||||||
|
|
||||||
This is a [sherlock](https://github.com/sherlock-project/) fork with cool features under heavy development.
|
Currently supported more than 2000 sites ([full list](./sites.md)), search is launched against 500 popular sites in descending order of popularity by default.
|
||||||
*Don't forget to regularly update source code from repo*.
|
|
||||||
|
|
||||||
Currently supported more than 2000 sites ([full list](./sites.md)), by default search is launched against 500 popular sites in descending order of popularity.
|
|
||||||
|
|
||||||
## Main features
|
## Main features
|
||||||
|
|
||||||
* Profile pages parsing, [extracting](https://github.com/soxoj/socid_extractor) personal info, links to other profiles, etc.
|
* Profile pages parsing, [extraction](https://github.com/soxoj/socid_extractor) of personal info, links to other profiles, etc.
|
||||||
* Recursive search by new usernames found
|
* Recursive search by new usernames and other ids found
|
||||||
* Search by tags (site categories, countries)
|
* Search by tags (site categories, countries)
|
||||||
* Censorship and captcha detection
|
* Censorship and captcha detection
|
||||||
* Very few false positives
|
* Requests retries
|
||||||
* Failed requests' restarts
|
|
||||||
|
See full description of Maigret features [in the Wiki](https://github.com/soxoj/maigret/wiki/Features).
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
**NOTE**: Python 3.6 or higher and pip is required.
|
Maigret can be installed using pip, Docker, or simply can be launched from the cloned repo.
|
||||||
|
Also you can run Maigret using cloud shells (see buttons below).
|
||||||
|
|
||||||
**Python 3.8 is recommended.**
|
[](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/soxoj/maigret&tutorial=README.md) [](https://repl.it/github/soxoj/maigret)
|
||||||
|
<a href="https://colab.research.google.com/gist//soxoj/879b51bc3b2f8b695abb054090645000/maigret.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab" height="40"></a>
|
||||||
|
|
||||||
### Package installing
|
### Package installing
|
||||||
|
|
||||||
|
**NOTE**: Python 3.6 or higher and pip is required, **Python 3.8 is recommended.**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# install from pypi
|
# install from pypi
|
||||||
pip3 install maigret
|
pip3 install maigret
|
||||||
@@ -42,34 +57,36 @@ pip3 install maigret
|
|||||||
# or clone and install manually
|
# or clone and install manually
|
||||||
git clone https://github.com/soxoj/maigret && cd maigret
|
git clone https://github.com/soxoj/maigret && cd maigret
|
||||||
pip3 install .
|
pip3 install .
|
||||||
|
|
||||||
|
# usage
|
||||||
|
maigret username
|
||||||
```
|
```
|
||||||
|
|
||||||
### Cloning a repository
|
### Cloning a repository
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/soxoj/maigret && cd maigret
|
git clone https://github.com/soxoj/maigret && cd maigret
|
||||||
```
|
|
||||||
|
|
||||||
You can use a free virtual machine, the repo will be automatically cloned:
|
|
||||||
|
|
||||||
[](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/soxoj/maigret&tutorial=README.md) [](https://repl.it/github/soxoj/maigret)
|
|
||||||
<a href="https://colab.research.google.com/gist//soxoj/879b51bc3b2f8b695abb054090645000/maigret.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab" height="40"></a>
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pip3 install -r requirements.txt
|
pip3 install -r requirements.txt
|
||||||
|
|
||||||
|
# usage
|
||||||
|
./maigret.py username
|
||||||
```
|
```
|
||||||
|
|
||||||
## Using examples
|
### Docker
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# for a cloned repo
|
# official image
|
||||||
./maigret.py user
|
docker pull soxoj/maigret
|
||||||
|
|
||||||
# for a package
|
# usage
|
||||||
maigret user
|
docker run soxoj/maigret:latest username
|
||||||
|
|
||||||
|
# manual build
|
||||||
|
docker build -t maigret .
|
||||||
```
|
```
|
||||||
|
|
||||||
Features:
|
## Usage examples
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# make HTML and PDF reports
|
# make HTML and PDF reports
|
||||||
maigret user --html --pdf
|
maigret user --html --pdf
|
||||||
@@ -77,22 +94,12 @@ maigret user --html --pdf
|
|||||||
# search on sites marked with tags photo & dating
|
# search on sites marked with tags photo & dating
|
||||||
maigret user --tags photo,dating
|
maigret user --tags photo,dating
|
||||||
|
|
||||||
|
|
||||||
# search for three usernames on all available sites
|
# search for three usernames on all available sites
|
||||||
maigret user1 user2 user3 -a
|
maigret user1 user2 user3 -a
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Run `maigret --help` to get arguments description. Also options are documented in [the Maigret Wiki](https://github.com/soxoj/maigret/wiki/Command-line-options).
|
Use `maigret --help` to get full options description. Also options are documented in [the Maigret Wiki](https://github.com/soxoj/maigret/wiki/Command-line-options).
|
||||||
|
|
||||||
With Docker:
|
|
||||||
```
|
|
||||||
# manual build
|
|
||||||
docker build -t maigret . && docker run maigret user
|
|
||||||
|
|
||||||
# official image
|
|
||||||
docker run soxoj/maigret:latest user
|
|
||||||
```
|
|
||||||
|
|
||||||
## Demo with page parsing and recursive username search
|
## Demo with page parsing and recursive username search
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user