SherlockBot is designed to interface with the Sherlock project. It allows users to search for usernames on various social networks directly from Matrix using the power of Sherlock.
Created by RocketGod
Modified for Matrix ecosystem by NeedNotApply
This bot requires the Sherlock project to function. If you haven't already cloned the Sherlock repository, you can do so with the following command:
git clone https://github.com/sherlock-project/sherlock- Navigate to the
sherlock_projectdirectory:
cd sherlock
cd sherlock_project- Clone the Watson repository into the
sherlock_projectdirectory:
git clone https://github.com/neednotapply/watson-matrix- Update the
config.jsonfile with your Matrix and optional Discord settings. The Matrix keys are grouped together to avoid confusion. Yourconfig.jsonshould look like this:
{
"matrix": {
"homeserver": "https://matrix.org",
"username": "@your_bot:matrix.org",
"password": "your_bot_password"
},
"discord": {
"token": "your_discord_bot_token"
}
}pip install matrix-nio aiohttp discord.py- Execute the
watson.pyscript:
py watson.pyWith both Matrix and Discord credentials in config.json, Watson will connect
to both platforms simultaneously. Matrix uses ! commands, and Discord exposes
slash commands once the bot starts.
Once the bot is running, you can utilize the following commands on your Matrix Room:
!sherlock [username]: Search for a specific username.!sherlock-similar: Check for similar usernames by replacing them with variations (e.g., '_', '-', '.').!help: Displays a list of available commands and their descriptions.
On Discord, Watson registers slash commands instead of prefix commands:
/sherlock <username>: Search for a specific username./sherlock-similar <username>: Check for similar usernames with variations./help: Lists available Watson commands.
Thank you for using Watson! If you find any issues or have any feedback, feel free to contribute to the Watson repository.