From 0f37a3592881171c56af356eaea7f1274f1113d4 Mon Sep 17 00:00:00 2001 From: Iain-S <25081046+Iain-S@users.noreply.github.com> Date: Fri, 9 Aug 2024 09:30:03 +0100 Subject: [PATCH] Add pre-commit safety instructions --- docs/content/setup.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/content/setup.md b/docs/content/setup.md index ff13e20..3942a73 100644 --- a/docs/content/setup.md +++ b/docs/content/setup.md @@ -23,14 +23,20 @@ You should also install [pre-commit](https://pre-commit.com) and install the pre pre-commit install --install-hooks ``` -set an environment variable with your [safety API key](https://docs.safetycli.com/safety-docs/support/invalid-api-key-error#how-to-get-a-safety-api-key): +run the non-safety pre-commit hooks with + +```bash +pre-commit run --all-files +``` + +set an environment variable with your [safety API key](https://docs.safetycli.com/safety-docs/support/invalid-api-key-error#how-to-get-a-safety-api-key) ```bash export SAFETY_API_KEY=your-api-key ``` -and run the checks with +and run the safety hook with ```bash -pre-commit run --all-files +pre-commit run --all-files --config .pre-commit-safety.yaml ```