You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28-28Lines changed: 28 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,21 +22,21 @@ As this tool use the [VirusTotal API](https://developers.virustotal.com/v3.0/ref
22
22
23
23
For installing the tool you can download one the [pre-compiled binaries](https://github.com/VirusTotal/vt-cli/releases) we offer for Windows, Linux and Mac OS X, or alternatively you can compile it yourself from source code. For compiling the program you'll need Go 1.14.x or higher installed in your system and type the following commands:
24
24
25
-
```
25
+
```sh
26
26
$ git clone https://github.com/VirusTotal/vt-cli
27
27
$ cd vt-cli
28
28
$ make install
29
29
```
30
30
31
31
NOTE: in order to use the `vt` binary, make sure the `GOBIN` is part of your `PATH` env variable:
32
-
```
32
+
```sh
33
33
$ export GOBIN=`go env GOPATH`/bin
34
34
$ export PATH=$PATH:$GOBIN
35
35
```
36
36
37
37
#### Mac OS
38
38
For Mac OS users, there's a [brew formula](https://formulae.brew.sh/formula/virustotal-cli) available. Please note this is not maintained by VirusTotal.
39
-
```
39
+
```sh
40
40
$ brew install virustotal-cli
41
41
```
42
42
@@ -49,7 +49,7 @@ If you plan to use vt-cli in Windows on a regular basis we highly recommend you
49
49
50
50
Once you have installed the vt-cli tool you may want to configure it with your API key. This is not strictly necessary, as you can provide your API key every time you invoke the tool by using the `--apikey` option (`-k` in short form), but that's a bit of a hassle if you are going to use the tool frequently (and we bet you'll do!). For configuring your API key just type:
51
51
52
-
```
52
+
```sh
53
53
$ vt init
54
54
```
55
55
@@ -59,13 +59,13 @@ This command will ask for your API key, and save it to a config file in your hom
59
59
60
60
If you are behind a HTTP proxy you can tell `vt-cli` which is the address of your proxy server by multiple ways. One is using the `--proxy` option, like in:
61
61
62
-
```
62
+
```sh
63
63
$ vt --proxy http://myproxy.com:1234 <command>
64
64
```
65
65
66
66
You can also use the `VTCLI_PROXY` environment variable, or add the following line to the config file:
If you are going to use this tool frequently you may want to have command auto-completion. It saves both precious time and keystrokes. Notice however that you must configure your API as described in the previous section *before* following the steps listed below. The API is necessary for determining the commands that you will have access to.
@@ -198,7 +198,7 @@ When you ask for information about a file, URL, domain, IP address or any other
198
198
199
199
These options accept patterns that are matched against the fields composing the data, and allow you to include only a subset of them, or exclude any field that is not interesting for you. Let's see how it works using the data we have about `http://www.virustotal.com` as an example:
@@ -252,20 +252,20 @@ The filters accepted by both `--include` and `--exclude` are paths in which we c
252
252
253
253
For cherry-picking only the fields you want, you should use `--include` followed by a path pattern as explained above. You can also include more than one pattern either by using the `--include` argument multiple times, or by using it with a comma-separated list of patterns. The following two options are equivalent:
0 commit comments