Skip to content

Commit

Permalink
add clarification to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Dmitriusan committed Oct 27, 2023
1 parent bcfe72c commit 2b710b0
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ consists of:

# Batch vulnerability scanner
The script splits source code files into chunks (trying to split between methods), uploads these files recursively to
GPT and asks it to scan the code for vulnerabilities. Findings are then grouped and pretty-printed
GPT and asks it to scan the code for vulnerabilities. Findings are then grouped and pretty-printed. Note: depending
on prompt and model used, findings may be too paranoid and consist almost entirely from false positives. You may
want to adjust `prompts/vulnerabilities/analyze` prompts to your case
## Usage
```shell
export OPENAI_API_KEY=<your API key>
Expand Down

0 comments on commit 2b710b0

Please sign in to comment.