Skip to content

Commit 3a07b3b

Browse files
committed
Update README
1 parent c509959 commit 3a07b3b

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,21 @@ Currently supported tools include:
7676
- gosec (https://github.com/securego/gosec)
7777
- semgrep (https://semgrep.dev/)
7878

79+
For imports to be successful, we recommend running commands as follows (exporting results as JSON), and making sure to run these tools from the project's folder (so that all relative paths can be processed correctly):
80+
81+
```bash
82+
# bandit
83+
bandit -f json -o bandit-results.json -r .
84+
# brakeman
85+
brakeman -f json -o brakeman-results.json .
86+
# checkov
87+
checkov -d . -o json --output-file-path checkov-results.json
88+
# gosec
89+
gosec -fmt=json -out=gosec-results.json ./...
90+
# semgrep
91+
semgrep scan --json -o semgrep-results.json --config=auto .
92+
```
93+
7994
## Extension Settings
8095

8196
Various settings for the extension can be configured in VSCode's User Settings page (`CMD+Shift+P` / `Ctrl + Shift + P` -> _Preferences: Open Settings (UI)_):

0 commit comments

Comments
 (0)