Skip to content

Commit

Permalink
docs: added documentation for scan command
Browse files Browse the repository at this point in the history
  • Loading branch information
Allan2000-Git committed Sep 22, 2024
1 parent 74804b1 commit 88e1e65
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions docs/cli/scan.md
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.

0 comments on commit 88e1e65

Please sign in to comment.