mirror of
https://github.com/soxoj/maigret.git
synced 2026-05-06 14:08:59 +00:00
Copilot
23adc178ea
* Initial plan * Fix crash on -a --self-check by adding exception handling in site_self_check and self_check Wrap the body of site_self_check in try/except to catch unexpected errors and always return a valid changes dict. Also add a safety-net try/except in self_check around awaiting individual site check futures so that a single site failure doesn't crash the entire self-check process. Agent-Logs-Url: https://github.com/soxoj/maigret/sessions/5e27d620-5cbb-43d2-a9f9-ecb53a29904d Co-authored-by: soxoj <31013580+soxoj@users.noreply.github.com> * Restore @pytest.mark.slow on test_maigret_results Agent-Logs-Url: https://github.com/soxoj/maigret/sessions/5e27d620-5cbb-43d2-a9f9-ecb53a29904d Co-authored-by: soxoj <31013580+soxoj@users.noreply.github.com> * Document --self-check error resilience, --auto-disable, and --diagnose in docs/ Update command-line-options.rst with expanded --self-check description and new --auto-disable and --diagnose entries. Add a "Database self-check" section to features.rst explaining error-resilient behaviour and usage examples. Update usage-examples.rst to reference --auto-disable. Agent-Logs-Url: https://github.com/soxoj/maigret/sessions/af1f0f09-9112-4902-8475-e81d235ff3ed Co-authored-by: soxoj <31013580+soxoj@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: soxoj <31013580+soxoj@users.noreply.github.com>
81 lines
2.1 KiB
ReStructuredText
81 lines
2.1 KiB
ReStructuredText
.. _usage-examples:
|
|
|
|
Usage examples
|
|
==============
|
|
|
|
You can use Maigret as:
|
|
|
|
- a command line tool: initial and a default mode
|
|
- a `web interface <#web-interface>`_: view the graph with results and download all report formats on a single page
|
|
- a library: integrate Maigret into your own project
|
|
|
|
Use Cases
|
|
---------
|
|
|
|
|
|
1. Search for accounts with username ``machine42`` on top 500 sites (by default, according to Majestic Million rank) from the Maigret DB.
|
|
|
|
.. code-block:: console
|
|
|
|
maigret machine42
|
|
|
|
2. Search for accounts with username ``machine42`` on **all sites** from the Maigret DB.
|
|
|
|
.. code-block:: console
|
|
|
|
maigret machine42 -a
|
|
|
|
.. note::
|
|
Maigret will search for accounts on a huge number of sites,
|
|
and some of them may return false positive results. At the moment, we are working on autorepair mode to deliver
|
|
the most accurate results.
|
|
|
|
If you experience many false positives, you can do the following:
|
|
|
|
- Install the last development version of Maigret from GitHub
|
|
- Run Maigret with ``--self-check --auto-disable`` flag and agree on disabling of problematic sites
|
|
|
|
3. Search for accounts with username ``machine42`` and generate HTML and PDF reports.
|
|
|
|
.. code-block:: console
|
|
|
|
maigret machine42 -HP
|
|
|
|
or
|
|
|
|
.. code-block:: console
|
|
|
|
maigret machine42 -a --html --pdf
|
|
|
|
|
|
4. Search for accounts with username ``machine42`` on Facebook only.
|
|
|
|
.. code-block:: console
|
|
|
|
maigret machine42 --site Facebook
|
|
|
|
5. Extract information from the Steam page by URL and start a search for accounts with found username ``machine42``.
|
|
|
|
.. code-block:: console
|
|
|
|
maigret --parse https://steamcommunity.com/profiles/76561199113454789
|
|
|
|
6. Search for accounts with username ``machine42`` only on US and Japanese sites.
|
|
|
|
.. code-block:: console
|
|
|
|
maigret machine42 --tags us,jp
|
|
|
|
7. Search for accounts with username ``machine42`` only on sites related to software development.
|
|
|
|
.. code-block:: console
|
|
|
|
maigret machine42 --tags coding
|
|
|
|
8. Search for accounts with username ``machine42`` on uCoz sites only (mostly CIS countries).
|
|
|
|
.. code-block:: console
|
|
|
|
maigret machine42 --tags ucoz
|
|
|