From 42a5e30c65c52a4f9cc5e185875b800817bcc58a Mon Sep 17 00:00:00 2001 From: Allan Joston Fernandes Date: Sun, 22 Sep 2024 16:02:42 +0530 Subject: [PATCH 1/2] docs: added documentation for scan command --- docs/cli/scan.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 docs/cli/scan.md diff --git a/docs/cli/scan.md b/docs/cli/scan.md new file mode 100644 index 00000000..a6fd4250 --- /dev/null +++ b/docs/cli/scan.md @@ -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 ` + +Scan a specific file. + +### `-c, --current-changes` + +Scan only the current changed files that are not committed. From 5793a76f446661207a6c64021c4b49f6bac45fb4 Mon Sep 17 00:00:00 2001 From: Allan Joston Fernandes Date: Sun, 22 Sep 2024 18:59:33 +0530 Subject: [PATCH 2/2] feat: added usage example to each option --- docs/cli/scan.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/cli/scan.md b/docs/cli/scan.md index a6fd4250..41622877 100644 --- a/docs/cli/scan.md +++ b/docs/cli/scan.md @@ -20,6 +20,18 @@ These are the options supported by the `scan` command: Scan a specific file. +Example: + +```bash +keyshade scan -f path/to/your/file.js +``` + ### `-c, --current-changes` Scan only the current changed files that are not committed. + +Example: + +```bash +keyshade scan -c +```