Skip to content

Commit

Permalink
Add installation methodd
Browse files Browse the repository at this point in the history
  • Loading branch information
qu35t-code committed Jan 8, 2024
1 parent 0bf52f8 commit 7376f4b
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<img src="/assets/logo.png" style='width:50%;height:50%'>
</div>

<a href="https://github.com/GoToolSharing/htb-cli" target="_blank">htb-cli</a> is a project developed and maintained by <a href="https://github.com/QU35T-code/" target="_blank">QU35T-code</a>. It interacts with the **API of <a href="https://app.hackthebox.com/" target="_blank">HackTheBox</a>**, a popular cybersecurity platform.
<a href="https://github.com/GoToolSharing/htb-cliS" target="_blank">htb-cli</a> is a project developed and maintained by <a href="https://github.com/QU35T-code/" target="_blank">QU35T-code</a>. It interacts with the **API of <a href="https://app.hackthebox.com/" target="_blank">HackTheBox</a>**, 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
Expand Down
25 changes: 24 additions & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
@@ -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 (<a href="https://go.dev/doc/install" target="_blank">https://go.dev/doc/install</a>).

Expand All @@ -22,6 +22,29 @@ export GOPATH=$HOME/go
export PATH=$PATH:$GOROOT/bin:$GOPATH/bin
```

## Stable version from sources

```bash
git clone [email protected]: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:
Expand Down

0 comments on commit 7376f4b

Please sign in to comment.