Skip to content

Commit 86b5069

Browse files
authored
docs: Include troubleshooting install instructions (#68)
1 parent 74c6596 commit 86b5069

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,18 @@ $ cd vt-cli
2828
$ make install
2929
```
3030

31+
NOTE: in order to use the `vt` binary, make sure the `GOBIN` is part of your `PATH` env variable:
32+
```
33+
$ export GOBIN=`go env GOPATH`/bin
34+
$ export PATH=$PATH:$GOBIN
35+
```
36+
37+
#### Mac OS
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+
```
40+
$ brew install virustotal-cli
41+
```
42+
3143
### A note on Window's console
3244

3345
If you plan to use vt-cli in Windows on a regular basis we highly recommend you to avoid the standard Windows's console and use [Cygwin](https://www.cygwin.com/) instead. The Windows's console is *very* slow when printing large amounts of text (as vt-cli usually does) while Cygwin performs much better. Additionally, you can benefit of Cygwin's support for command auto-completion, a handy feature that Window's console doesn't offer. In order to take advantage of auto-completion make sure to include the `bash-completion` package while installing Cygwin.
@@ -145,6 +157,25 @@ Restart the shell.
145157
```
146158
$ vt search "positives:5+ type:pdf"
147159
```
160+
161+
* Scan a file:
162+
```
163+
$ vt scan file <yourfile>
164+
<yourfile> ZDZiOTcxY2JhNDE0MWU5ZWRjN2JjNGQ2NTdhN2VjODU6MTU3MDE3Mjg1NQ==
165+
$ vt analysis ZDZiOTcxY2JhNDE0MWU5ZWRjN2JjNGQ2NTdhN2VjODU6MTU3MDE3Mjg1NQ==
166+
- _id: "ZDZiOTcxY2JhNDE0MWU5ZWRjN2JjNGQ2NTdhN2VjODU6MTU3MDE3Mjg1NQ=="
167+
_type: "analysis"
168+
date: 1570172855 # 2019-10-04 09:07:35 +0200 CEST
169+
stats:
170+
failure: 0
171+
harmless: 0
172+
malicious: 0
173+
suspicious: 0
174+
timeout: 0
175+
type-unsupported: 0
176+
undetected: 0
177+
status: "queued"
178+
```
148179

149180
## Getting only what you want
150181

0 commit comments

Comments
 (0)