Skip to content

Commit eeb350e

Browse files
authored
Add usage explanation on README.md with examples
1 parent 9257a58 commit eeb350e

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,9 @@ To run **Snapper** using npm, you can use the following command:
5757

5858
```bash
5959
npx snapper --help
60+
61+
# Or, if installed globally
62+
snapper --help
6063
```
6164

6265
This will show you the available options for **Snapper**. Here's an example output:
@@ -79,6 +82,24 @@ Options:
7982
-h, --help Show help [boolean]
8083
```
8184

85+
To run on a Snap:
86+
```bash
87+
# Basic scan
88+
snapper --path /path/to/snap
89+
90+
# Ignore detectors when they aren't relevant or too verbose.
91+
snapper --path /path/to/snap --ignoreDetectors detector1,detector2
92+
93+
# Run only specific detectors, useful for development when fixing a specific issue.
94+
snapper --path /path/to/snap --detectors detector1,detector2
95+
96+
# Generate HTML report
97+
snapper --path /path/to/snap --htmlReport
98+
99+
# Log output to a file
100+
snapper --path /path/to/snap --logFile /path/to/logs.txt
101+
```
102+
82103
To run a test case:
83104

84105
```bash

0 commit comments

Comments
 (0)