Skip to content

Commit

Permalink
Correct the paths given in getting start examples (#438)
Browse files Browse the repository at this point in the history
The Getting Started has examples with paths that don't exist. This
change corrects those paths.

Signed-off-by: Eric Brown <eric.brown@securesauce.dev>
  • Loading branch information
ericwb committed Apr 23, 2024
1 parent d9a9bea commit 30b7bbd
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,31 +14,31 @@ pip install precli
Run precli on a single test example:

```
precli tests/unit/rules/python/stdlib/examples/hmac_timing_attack.py
precli tests/unit/rules/python/stdlib/hmac/examples/hmac_timing_attack.py
```

Run precli on a single test example, showing results in SARIF format:

```
precli tests/unit/rules/python/stdlib/examples/hmac_timing_attack.py --json
precli tests/unit/rules/python/stdlib/hmac/examples/hmac_timing_attack.py --json
```

Run precli on a single test example, showing results in plain format:

```
precli tests/unit/rules/python/stdlib/examples/hmac_timing_attack.py --plain
precli tests/unit/rules/python/stdlib/hmac/examples/hmac_timing_attack.py --plain
```

Run precli on a single test example, showing results in markdown format:

```
precli tests/unit/rules/python/stdlib/examples/hmac_timing_attack.py --markdown
precli tests/unit/rules/python/stdlib/hmac/examples/hmac_timing_attack.py --markdown
```

Run precli against all the python test examples:

```
precli -r tests/unit/rules/python/stdlib/examples/
precli -r tests/unit/rules/python/
```

Run precli against an entire GitHub repository:
Expand Down

0 comments on commit 30b7bbd

Please sign in to comment.