diff --git a/docs/assets/commands/reset/reset.png b/docs/assets/commands/reset/reset.png new file mode 100644 index 0000000..81a0c2b Binary files /dev/null and b/docs/assets/commands/reset/reset.png differ diff --git a/docs/assets/commands/start/ra.png b/docs/assets/commands/start/ra.png new file mode 100644 index 0000000..bc0fc4b Binary files /dev/null and b/docs/assets/commands/start/ra.png differ diff --git a/docs/assets/commands/start/search.png b/docs/assets/commands/start/search.png new file mode 100644 index 0000000..1565cd2 Binary files /dev/null and b/docs/assets/commands/start/search.png differ diff --git a/docs/assets/commands/status/status.png b/docs/assets/commands/status/status.png new file mode 100644 index 0000000..fc5398d Binary files /dev/null and b/docs/assets/commands/status/status.png differ diff --git a/docs/assets/commands/status/web.png b/docs/assets/commands/status/web.png new file mode 100644 index 0000000..e01580a Binary files /dev/null and b/docs/assets/commands/status/web.png differ diff --git a/docs/assets/commands/stop/stop.png b/docs/assets/commands/stop/stop.png new file mode 100644 index 0000000..8823222 Binary files /dev/null and b/docs/assets/commands/stop/stop.png differ diff --git a/docs/assets/commands/submit/active.png b/docs/assets/commands/submit/active.png new file mode 100644 index 0000000..9d72c17 Binary files /dev/null and b/docs/assets/commands/submit/active.png differ diff --git a/docs/assets/commands/submit/challenge.png b/docs/assets/commands/submit/challenge.png new file mode 100644 index 0000000..da0f204 Binary files /dev/null and b/docs/assets/commands/submit/challenge.png differ diff --git a/docs/assets/commands/submit/machine.png b/docs/assets/commands/submit/machine.png new file mode 100644 index 0000000..ab38647 Binary files /dev/null and b/docs/assets/commands/submit/machine.png differ diff --git a/docs/commands/reset.md b/docs/commands/reset.md new file mode 100644 index 0000000..89dece1 --- /dev/null +++ b/docs/commands/reset.md @@ -0,0 +1,9 @@ +# Reset + +The **reset** command is used to **request the reset** of an instance. **No arguments** are required. The reset request will be made for the **current active machine**. + +```bash +htb-cli reset +``` + +![Reset](/assets/commands/reset/reset.png) \ No newline at end of file diff --git a/docs/commands/start.md b/docs/commands/start.md new file mode 100644 index 0000000..25a3dea --- /dev/null +++ b/docs/commands/start.md @@ -0,0 +1,23 @@ +# Start + +## Machine search + +The **start** command starts an instance for a machine. The **machine name** must be specified using the `-m` or `--machine` argument. Once started, its **IP address** is displayed. + +```bash +htb-cli start -m Visual +``` + +![Search](/assets/commands/start/search.png) + +## Start the release arena machine + +If **no flag** is submitted, htb-cli starts the machine in **release arena**. + +```bash +htb-cli start +``` + +![Release Arena](/assets/commands/start/ra.png) + +**Note:** The **release arena** machine can also be started by specifying its name with the `-m` flag. \ No newline at end of file diff --git a/docs/commands/status.md b/docs/commands/status.md new file mode 100644 index 0000000..a5c193e --- /dev/null +++ b/docs/commands/status.md @@ -0,0 +1,12 @@ +# Status + +The **status** command displays the status of **hackthebox servers**. +A request is made to the following URL to retrieve the status: https://status.hackthebox.com/api/v2/status.json + +![Web](/assets/commands/status/web.png) + +```bash +htb-cli status +``` + +![Status](/assets/commands/status/status.png) \ No newline at end of file diff --git a/docs/commands/stop.md b/docs/commands/stop.md new file mode 100644 index 0000000..74aa4c0 --- /dev/null +++ b/docs/commands/stop.md @@ -0,0 +1,9 @@ +# Stop + +The **stop** command is used to **stop a machine instance**. **No arguments** are required. The **current active machine** will be stopped. + +```bash +htb-cli stop +``` + +![Stop](/assets/commands/stop/stop.png) \ No newline at end of file diff --git a/docs/commands/submit.md b/docs/commands/submit.md new file mode 100644 index 0000000..1f18c77 --- /dev/null +++ b/docs/commands/submit.md @@ -0,0 +1,41 @@ +# Submit + +The **submit** command is used to **submit a flag**. Currently, the following submissions are supported : + +* VIP machines +* VIP+ machines +* Free machines +* Release Arena machines +* Challenges + +The `-d` or `--difficulty` flag must be used to indicate the **difficulty** of obtaining the flag. + +## Active machine + +If there is no `--machine` or `--challenge` flag, submission will be made on the **current active machine**. + +```bash +htb-cli submit -d 3 +``` + +![Active](/assets/commands/submit/active.png) + +## Find a machine + +A **machine name** can be specified to submit the flag for a specific machine. The `-m` or `--machine` option can be used for this. + +```bash +htb-cli submit -m Sau -d 3 +``` + +![Machine](/assets/commands/submit/machine.png) + +## Challenge + +To **submit a challenge** flag, you can specify its name with the `-c` flag. + +```bash +htb-cli submit -c OOPArtDB -d 10 +``` + +![Challenge](/assets/commands/submit/challenge.png) \ No newline at end of file diff --git a/docs/commands/vpn.md b/docs/commands/vpn.md new file mode 100644 index 0000000..4bbc3e1 --- /dev/null +++ b/docs/commands/vpn.md @@ -0,0 +1,2 @@ +# VPN + diff --git a/mkdocs.yml b/mkdocs.yml index 6a4943f..092dcdc 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -52,4 +52,10 @@ nav: - Sherlocks: commands/sherlocks.md - Info: commands/info.md - Machines: commands/machines.md + - Start: commands/start.md + - Stop: commands/stop.md + - Reset: commands/reset.md + - Status: commands/status.md + - Submit: commands/submit.md + - VPN: commands/vpn.md \ No newline at end of file