-
-
Notifications
You must be signed in to change notification settings - Fork 115
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: added documentation for scan command
- Loading branch information
1 parent
74804b1
commit 88e1e65
Showing
1 changed file
with
25 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
description: The `scan` command | ||
--- | ||
|
||
# `scan` | ||
|
||
The `scan` command is used to detect any hardcoded secrets in your project files. It can scan specific files, only changed files, or all files in the project. | ||
|
||
## Usage | ||
|
||
```bash | ||
keyshade scan [options] | ||
``` | ||
|
||
## Options | ||
|
||
These are the options supported by the `scan` command: | ||
|
||
### `-f, --file <string>` | ||
|
||
Scan a specific file. | ||
|
||
### `-c, --current-changes` | ||
|
||
Scan only the current changed files that are not committed. |