diff --git a/.pre-commit-hooks.yaml b/.pre-commit-hooks.yaml new file mode 100644 index 000000000..d561ca429 --- /dev/null +++ b/.pre-commit-hooks.yaml @@ -0,0 +1,9 @@ +- id: slither + name: Slither + description: Run Slither on your project + entry: slither + args: + - . + pass_filenames: false + language: python + files: \.sol$ diff --git a/README.md b/README.md index 515d6a9f7..660f4f8e8 100644 --- a/README.md +++ b/README.md @@ -102,6 +102,13 @@ docker run -it -v /home/share:/share trailofbits/eth-security-toolbox ### Integration * For GitHub action integration, use [slither-action](https://github.com/marketplace/actions/slither-action). +* For pre-commit integration, use (replace `$GIT_TAG` with real tag) + ```YAML + - repo: https://github.com/crytic/slither + rev: $GIT_TAG + hooks: + - id: slither + ``` * To generate a Markdown report, use `slither [target] --checklist`. * To generate a Markdown with GitHub source code highlighting, use `slither [target] --checklist --markdown-root https://github.com/ORG/REPO/blob/COMMIT/` (replace `ORG`, `REPO`, `COMMIT`)