awatertrevi/infisical
1
0
Fork 0
mirror of https://github.com/awatertrevi/infisical.git synced 2026-09-22 13:39:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

improve pre commit docs

Browse Source
This commit is contained in:
Maidul Islam
2023-05-23 19:45:10 -04:00
parent f2de1778cb
commit a7fb0786f9
3 changed files with 49 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/cli/scanning-overview.mdx
View File

@@ -52,6 +52,30 @@ In addition to scanning for past leaks, this new addition also actively aids in
</Tab>
</Tabs>
#
#
# Automatically scan changes before you commit
To lower the risk of committing hardcoded secrets to your code repository, we have designed a custom git pre-commit hook.
This hook scans the changes you're about to commit for any exposed secrets. If any hardcoded secrets are detected, it will block your commit.
### Install pre-commit hook
To install this git hook, go into your local git repository and run the following command.
```bash
infisical scan install --pre-commit-hook
```
To disable this hook after installing it, run the command `git config --bool hooks.infisical-scan false`
### Third party hooks management
If you prefer to manage your pre-commit hook outside of the .git/hooks directory, you can easily accomplish this by adding the following command to your pre-commit script
```bash
infisical scan git-changes --staged --verbose
```
#
#
# Creating a baseline