Skip to content

Commit

Permalink
docs: Improve install section in README (#83)
Browse files Browse the repository at this point in the history
The current install section led to misunderstandings since it looked like compiling the binary is the only option available. This PR aims to restructure this section to highlight the option of using pre-compiled binaries.
  • Loading branch information
mgmacias95 authored Sep 27, 2023
1 parent bfea504 commit f42150a
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,13 @@ As this tool use the [VirusTotal API](https://developers.virustotal.com/v3.0/ref

### Installing the tool

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. To compile the program you'll need [Go 1.14.x or higher installed in your system](https://go.dev/doc/install) and type the following commands:
There are two ways of installing the tool: by using one of our pre-compiled binaries or by building it by yourself.

#### Pre-compiled binaries
The pre-compiled binaries can be found at [the releases page](https://github.com/VirusTotal/vt-cli/releases). There are binaries for Windows, Linux and Mac OS X. To use them, just download the file, decompress it and place it in a directory where you think is more convenient to be used.

#### Manual building
To compile the program you'll need [Go 1.14.x or higher installed in your system](https://go.dev/doc/install) and type the following commands:

```sh
$ git clone https://github.com/VirusTotal/vt-cli
Expand All @@ -34,15 +40,15 @@ $ export GOBIN=`go env GOPATH`/bin
$ export PATH=$PATH:$GOBIN
```

#### Mac OS
##### Mac OS

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.

```sh
$ brew install virustotal-cli
```

#### Windows
##### Windows

For Windows uses, there's a [Winget manifest](https://github.com/microsoft/winget-pkgs/tree/master/manifests/v/VirusTotal/vt-cli) available. Please note this is not maintained by VirusTotal.

Expand Down

0 comments on commit f42150a

Please sign in to comment.