Skip to content

Commit aae71fc

Browse files
authored
Update README.md
Adding instructions on how to create and configure a VirusTotal API Key.
1 parent 1e4a14f commit aae71fc

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,18 @@ You may then load the token safely by using (prevents the token from being displ
4949
read -rs GH_ACCESS_TOKEN
5050
export
5151
```
52+
# Integration with VirusTotal
5253

54+
Gitxray can optionally use the VirusTotal API to check any hosts identified with GitHub's Code search API, but it requires a VirusTotal API Key to work. Instructions on how to get your VirusTotal API Key are available at: https://docs.virustotal.com/docs/please-give-me-an-api-key
55+
56+
Unfortunately, personal API Keys are (as of today) limited by VirusTotal to 500 lookups a day.
57+
58+
Once you have the API key, you may safely load it in your environment with:
59+
60+
```bash
61+
read -rs VT_API_KEY
62+
export
63+
```
5364
# Installing, Updating, and running Gitxray
5465

5566
gitxray was written with no use of external package dependencies other than the `requests` library.

0 commit comments

Comments
 (0)