mirror of
https://github.com/Infisical/infisical.git
synced 2026-01-09 15:38:03 -05:00
improve pre commit docs
This commit is contained in:
23
docs/cli/commands/scan-install.mdx
Normal file
23
docs/cli/commands/scan-install.mdx
Normal file
@@ -0,0 +1,23 @@
|
||||
---
|
||||
title: "scan install"
|
||||
description: "Add various scanning tools seamlessly into your development lifecycle"
|
||||
---
|
||||
|
||||
```bash
|
||||
infisical scan install --pre-commit-hook
|
||||
```
|
||||
|
||||
## Description
|
||||
The command `infisical scan install` is designed to incorporate various scanning tools seamlessly into your development lifecycle.
|
||||
Initially, we are offering users the ability to install a pre-commit hook. This hook conducts an automatic scan for any exposed secrets in your commits before they are pushed.
|
||||
|
||||
### Flags
|
||||
<Accordion title="--pre-commit-hook">
|
||||
```bash
|
||||
infisical scan install --pre-commit-hook
|
||||
```
|
||||
|
||||
**Description**
|
||||
Installs a git pre-commit hook that triggers Infisical to scan your staged changes for any exposed secrets prior to pushing.
|
||||
|
||||
</Accordion>
|
||||
@@ -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
|
||||
|
||||
@@ -154,7 +154,8 @@
|
||||
"group": "infisical scan",
|
||||
"pages": [
|
||||
"cli/commands/scan",
|
||||
"cli/commands/scan-git-changes"
|
||||
"cli/commands/scan-git-changes",
|
||||
"cli/commands/scan-install"
|
||||
]
|
||||
}
|
||||
]
|
||||
|
||||
Reference in New Issue
Block a user