docs: Add documentation for scan in CLI

[Allan2000-Git]

User description

Description

This PR adds documentation for the new scan feature in the CLI, providing users with clear instructions on how to utilize this functionality effectively.

Fixes #459

Dependencies

No new dependencies introduced.

Future Improvements

Consider adding examples for common use cases of the scan feature in future documentation updates.

Mentions

@rajdip-b

Screenshots of relevant screens

N/A

Developer's checklist

• My PR follows the style guidelines of this project
• I have performed a self-check on my work

If changes are made in the code:

• I have followed the coding guidelines
• My changes in code generate no new warnings
• My changes are breaking another fix/feature of the project
• I have added test cases to show that my feature works
• I have added relevant screenshots in my PR
• There are no UI/UX issues

Documentation Update

• This PR requires an update to the documentation at docs.keyshade.xyz
• I have made the necessary updates to the documentation, or no documentation changes are required.

---

PR Type

Documentation

---

Description

• Added comprehensive documentation for the new scan command in the CLI.
• Provided usage instructions and detailed options for scanning files.
• Aimed to help users detect hardcoded secrets in project files effectively.

---

Changes walkthrough 📝

	Relevant files
Documentation	scan.md Add documentation for the `scan` CLI command                          docs/cli/scan.md Added documentation for the scan command in the CLI. Included usage instructions and command options. Described options for scanning specific files or current changes. +25/-0

---

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

[codiumai-pr-agent-free]

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ No key issues to review

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Category	Suggestion	Score
Enhancement	✅ Add usage examples for each command option to enhance clarity and usability Suggestion Impact: The suggestion to add usage examples for the scan command options was implemented, improving the documentation's clarity. code diff: +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 +``` Consider adding a brief example of how to use the scan command with each option to make the documentation more practical and user-friendly. docs/cli/scan.md [19-25] ### `-f, --file <string>` 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 +``` + Apply this suggestion Suggestion importance[1-10]: 8 Why: Adding examples for each command option significantly improves the documentation's clarity and usability, making it easier for users to understand how to use the command effectively.	8
	Provide information about the expected output of the scan command Consider adding information about the output format or what users can expect after running the scan command. docs/cli/scan.md [5-13] # `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] +After running the scan, the command will output a list of detected secrets, if any, including their location and type. If no secrets are found, it will display a success message. + - [ ] **Apply this suggestion** <!-- /improve --apply_suggestion=1 --> <details><summary>Suggestion importance[1-10]: 8</summary> Why: Describing the expected output of the command helps users know what to look for after execution, enhancing the documentation's completeness and user experience. </details></details></td><td align=center>8 </td></tr><tr><td> <details><summary>Explain the default behavior of the scan command when no options are provided<!-- not_implemented --></summary> ___ **Consider adding information about the default behavior of the <code>scan</code> command when no <br>options are specified.** [docs/cli/scan.md [15-25]](https://github.com/keyshade-xyz/keyshade/pull/461/files#diff-4c9cc9e2c50e5ec27e10277c0a92db149bf5ae71aa4958e68bfb191935470cc8R15-R25) ```diff ## Options These are the options supported by the `scan` command: + +### Default behavior + +When no options are specified, the `scan` command will scan all files in the project. ### `-f, --file <string>` Scan a specific file. ### `-c, --current-changes` Scan only the current changed files that are not committed. Apply this suggestion Suggestion importance[1-10]: 7 Why: Including information about the default behavior when no options are specified is useful for users to understand the command's full functionality, though it is not as crucial as providing examples.	7

💡 Need additional feedback ? start a PR chat

[rajdip-b]

🎉 This PR is included in version 2.6.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀