Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update install docs #2160

Merged
merged 3 commits into from
Jun 17, 2024
Merged

Update install docs #2160

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7b8aed8
Update docs
ppfeister Jun 10, 2024
4098b26
Remove BlackArch
ppfeister Jun 17, 2024
4e1e237
Add BlackArch install command
ppfeister Jun 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,15 @@ pipx install sherlock-project

### Build live package from source (useful for contributors)

> [!Note]
> With the switch to Poetry, Sherlock no longer requires a `requirements.txt` file. Dependencies are now specified within the `pyproject.toml` file.
>
> If the legacy `requirements.txt` file is still desired, it can be dynamically generated:
> ```bash
> # Append `--with dev` or `--only dev` to include dev dependencies
> poetry export --without-hashes -f requirements.txt --output requirements.txt
> ```

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).
Expand Down
5 changes: 4 additions & 1 deletion docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,11 @@
| | Command | Notes |
| - | - | - |
| PyPI | `pipx install sherlock-project` | `pip` may be used in place of `pipx` |
| Homebrew | `brew install sherlock` | Community supported |
| Docker | `docker pull sherlock/sherlock` | |
| Debian family | `apt install sherlock` | Kali, Parrot, BlackArch, Testing, Sid |
ppfeister marked this conversation as resolved.
Show resolved Hide resolved
| Homebrew | `brew install sherlock` | |

PyPI and DockerHub images are mainaintenced by the Sherlock Project. Others are community supported.

### Alternative guides and methods

Expand Down
Loading