Installation
This is an officially supported package, maintained by a member of the Sherlock Project itself.
pipx is often recommended over pip, having more predictable behavior.
For those who prefer classic pip, it’s very similar. Userspace is recommended.
That’s it! You can now run sherlock from anywhere.
This is an officially supported package, maintained by a member of the Sherlock Project itself.
pipx is often recommended over pip, having more predictable behavior.
For those who prefer classic pip, it’s very similar. Userspace is recommended.
That’s it! You can now run sherlock from anywhere.
This package is not officially supported, but it’s maintained by a trusted packager.
That’s it! You can now run sherlock from anywhere.
This package is not officially supported, but it’s maintained under the trusted purview of the Debian Security Tools Packaging Team. The ParrotOS image is maintained by the ParrotOS team.
We may begin to officially support this package in the future.
Supported distributions are Kali and ParrotOS. Work is underway to support Debian, Ubuntu, and others.
That’s it! You can now run sherlock from anywhere.
This is an officially supported package, maintained by a member of the Sherlock Project itself.
Sherlock has out-of-the-box support for Fedora. Enterprise Linux support through EPEL is planned. Enterprise Linux distributions are RHEL, CentOS, Alma, Rocky, Oracle, and Scientific.
That’s it! You can now run sherlock from anywhere.
This package is not officially supported, but still closely follows our release cycle.
That’s it! You can now run sherlock from anywhere.
This is an officially supported image, maintained by a member of the Sherlock Project itself.
-o /opt/sherlock/results/{user123}.txt
(replace {user123}
) when an output file is desired at the mounted volume (as seen in the compose). This has no effect on stdout, which functions as expected out of the box.Using compose
Build image from source (useful for contributors)
While this method uses the official repository, it’s not an officially supported installation method. This method is recommended for contributors, packagers, and other users who need access to the source code.
Build live package from source (useful for contributors)
Building an editable (or live) package links the entry point to your current directory, rather than to the standard install location. This is often useful when working with the code base, as changes are reflected immediately without reinstallation.
Note that the version number will be 0.0.0 for pipx local builds unless manually changed in the pyproject file (it will prompt the user for an update).
Run package from source (without installing)
If you’d rather not install directly to your system, you can import the module at runtime with -m.