Skip to content

Commit

Permalink
docs: Add documentation for scan in CLI (keyshade-xyz#461)
Browse files Browse the repository at this point in the history
  • Loading branch information
Allan2000-Git authored and Kiranchaudhary537 committed Oct 13, 2024
1 parent 0cb3998 commit d023e44
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions docs/cli/scan.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
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.

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
```

0 comments on commit d023e44

Please sign in to comment.