From 77c11df1192d0366c56377ed94bd7db2a7f67344 Mon Sep 17 00:00:00 2001 From: Soxoj <31013580+soxoj@users.noreply.github.com> Date: Thu, 23 Apr 2026 21:45:27 +0200 Subject: [PATCH] Fix Google Cloud Shell launch (#2557) --- README.md | 2 +- cloudshell-tutorial.md | 69 ++++++++++++++++++++++++++++++++++ maigret/resources/db_meta.json | 2 +- utils/cloudshell_install.sh | 5 +++ 4 files changed, 76 insertions(+), 2 deletions(-) create mode 100644 cloudshell-tutorial.md create mode 100755 utils/cloudshell_install.sh diff --git a/README.md b/README.md index 87407c2..6086204 100644 --- a/README.md +++ b/README.md @@ -109,7 +109,7 @@ Download a standalone EXE from [Releases](https://github.com/soxoj/maigret/relea Run Maigret in the browser via cloud shells or Jupyter notebooks: -[![Open in Cloud Shell](https://user-images.githubusercontent.com/27065646/92304704-8d146d80-ef80-11ea-8c29-0deaabb1c702.png)](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/soxoj/maigret&tutorial=README.md) +[![Open in Cloud Shell](https://user-images.githubusercontent.com/27065646/92304704-8d146d80-ef80-11ea-8c29-0deaabb1c702.png)](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/soxoj/maigret&tutorial=cloudshell-tutorial.md) Run on Replit Open In Colab diff --git a/cloudshell-tutorial.md b/cloudshell-tutorial.md new file mode 100644 index 0000000..1cc704b --- /dev/null +++ b/cloudshell-tutorial.md @@ -0,0 +1,69 @@ +# Maigret + +
+ Maigret logo +
+ +**Maigret** collects 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. No API keys required. + +## Installation + +Google Cloud Shell does not ship with all the system libraries Maigret needs (`libcairo2-dev`, `pkg-config`). The helper script below installs them and then builds Maigret from the cloned source. + +Copy the command and run it in the Cloud Shell terminal: + +```bash +./utils/cloudshell_install.sh +``` + +When the script finishes, verify the install: + +```bash +maigret --version +``` + +## Usage examples + +Run a basic search for a username. By default Maigret checks the **500 highest-ranked sites by traffic** — pass `-a` to scan the full 3,000+ database. + +```bash +maigret soxoj +``` + +Search several usernames at once: + +```bash +maigret user1 user2 user3 +``` + +Narrow the run to sites related to cryptocurrency via the `crypto` tag (you can also use country tags): + +```bash +maigret vitalik.eth --tags crypto +``` + +Generate reports in HTML, PDF, and XMind 8 formats: + +```bash +maigret soxoj --html +maigret soxoj --pdf +maigret soxoj --xmind +``` + +Download a generated report from Cloud Shell to your local machine: + +```bash +cloudshell download reports/report_soxoj.pdf +``` + +Tune reliability on flaky networks — raise the timeout and retry failed checks: + +```bash +maigret soxoj --timeout 60 --retries 2 +``` + +For the full list of options see `maigret --help` or the [CLI documentation](https://maigret.readthedocs.io/en/latest/command-line-options.html). + +## Further reading + +Full project documentation: [maigret.readthedocs.io](https://maigret.readthedocs.io/) diff --git a/maigret/resources/db_meta.json b/maigret/resources/db_meta.json index b7fdcda..b11ade7 100644 --- a/maigret/resources/db_meta.json +++ b/maigret/resources/db_meta.json @@ -1,6 +1,6 @@ { "version": 1, - "updated_at": "2026-04-23T17:41:19Z", + "updated_at": "2026-04-23T19:44:45Z", "sites_count": 3139, "min_maigret_version": "0.6.0", "data_sha256": "35bfbb1271a50890c78a03d8e9d9f8d07f78de0e140c8232626de2f6eb124bae", diff --git a/utils/cloudshell_install.sh b/utils/cloudshell_install.sh new file mode 100755 index 0000000..3d43a5b --- /dev/null +++ b/utils/cloudshell_install.sh @@ -0,0 +1,5 @@ +#!/bin/bash +set -e + +sudo apt-get update && sudo apt-get install -y libcairo2-dev pkg-config +pip install .