Skip to content

[Update]: Readme - Installation via uv #2573

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

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

[Update]: Readme - Installation via uv #2573

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
* [Usage](#usage)
* [How to install](#how-to-install)
* [Using Pip](#using-pip)
* [Using Uv](#using-uv)
* [Using Git](#using-git)
* [Using Docker](#using-docker)
* [Integration](#integration)
Expand Down Expand Up @@ -76,6 +77,13 @@ If you're **not** going to use one of the [supported compilation frameworks](htt
python3 -m pip install slither-analyzer
```

### Using Uv

```console
uv pip install slither-analyzer
```
Recommended to first [initialize a uv project](https://docs.astral.sh/uv/guides/projects/#managing-dependencies), and then run the install command, this allows for isolation in the [uv virtual environment](https://docs.astral.sh/uv/pip/compatibility/#virtual-environments-by-default) by default which leads to significantly [faster installation times](https://github.com/xyizko/xo-i-euvs/#installation-times).

### Using Git

```bash
Expand Down
Loading