diff --git a/docs/index.md b/docs/index.md index b17da6f..9ceb7cf 100644 --- a/docs/index.md +++ b/docs/index.md @@ -22,7 +22,7 @@ -htb-cli is a project developed and maintained by QU35T-code. It interacts with the **API of HackTheBox**, a popular cybersecurity platform. +htb-cli is a project developed and maintained by QU35T-code. It interacts with the **API of HackTheBox**, a popular cybersecurity platform. It responds to the need to be **competitive**, limit user interaction with the website and **save time** with possible actions. ## Demonstration diff --git a/docs/installation.md b/docs/installation.md index c9c5519..21064d3 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,6 +1,6 @@ # Installation -## Stable version +## Stable version from remote The **stable version (main branch)** of `htb-cli` only requires `golang version 20` to be installed (https://go.dev/doc/install). @@ -22,6 +22,29 @@ export GOPATH=$HOME/go export PATH=$PATH:$GOROOT/bin:$GOPATH/bin ``` +## Stable version from sources + +```bash +git clone git@github.com:GoToolSharing/htb-cli.git +Cloning into 'htb-cli'... +remote: Enumerating objects: 1756, done. +remote: Counting objects: 100% (224/224), done. +remote: Compressing objects: 100% (131/131), done. +remote: Total 1756 (delta 106), reused 142 (delta 77), pack-reused 1532 +Receiving objects: 100% (1756/1756), 4.21 MiB | 3.27 MiB/s, done. +Resolving deltas: 100% (1083/1083), done. +``` + +```bash +cd htb-cli +go install . +``` + +```bash +htb-cli version +Stable version (main branch): v1.5.1 +``` + ## Development version The **development version (dev branch)** can be installed using the following command: