Installation

Shortscan is written in Go and can be installed easily if you have a Go environment set up. The go.mod file specifies that Go version 1.18 or newer is required.

Quick Install (Recommended)

The simplest way to install shortscan and the companion shortutil is using go install. This command will download, compile, and install the binaries into your Go bin directory ($GOPATH/bin).

go install github.com/bitquark/shortscan/cmd/shortscan@latest
go install github.com/bitquark/shortscan/cmd/shortutil@latest

Ensure that your $GOPATH/bin directory is in your system's PATH to run the tools from any location.

Manual Build from Source

If you prefer to build the project from a local copy, you can clone the repository and build it yourself.

1. Clone the repository:

   git clone https://github.com/bitquark/shortscan.git
   cd shortscan

2. Download dependencies and build the binary:

   This command compiles the shortscan tool in the current directory.

   go get && go build ./cmd/shortscan

3. (Optional) Install the binary:

   This command will place the compiled binary in your $GOPATH/bin directory.

   go install ./cmd/shortscan

4. Build and install shortutil:

   Repeat the process for the shortutil utility.

   go build ./cmd/shortutil
   go install ./cmd/shortutil