Add start,status,stop and submit pages

GoToolSharing · Jan 8, 2024 · b80911b · b80911b
1 parent e69126f
commit b80911b
Show file tree

Hide file tree

Showing 16 changed files with 102 additions and 0 deletions.
diff --git a/docs/assets/commands/reset/reset.png b/docs/assets/commands/reset/reset.png
diff --git a/docs/assets/commands/start/ra.png b/docs/assets/commands/start/ra.png
diff --git a/docs/assets/commands/start/search.png b/docs/assets/commands/start/search.png
diff --git a/docs/assets/commands/status/status.png b/docs/assets/commands/status/status.png
diff --git a/docs/assets/commands/status/web.png b/docs/assets/commands/status/web.png
diff --git a/docs/assets/commands/stop/stop.png b/docs/assets/commands/stop/stop.png
diff --git a/docs/assets/commands/submit/active.png b/docs/assets/commands/submit/active.png
diff --git a/docs/assets/commands/submit/challenge.png b/docs/assets/commands/submit/challenge.png
diff --git a/docs/assets/commands/submit/machine.png b/docs/assets/commands/submit/machine.png
diff --git a/docs/commands/reset.md 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)
diff --git a/docs/commands/start.md 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.
diff --git a/docs/commands/status.md 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: <a href="https://status.hackthebox.com/api/v2/status.json" target="_blank">https://status.hackthebox.com/api/v2/status.json</a>
+
+![Web](/assets/commands/status/web.png)
+
+```bash
+htb-cli status
+```
+
+![Status](/assets/commands/status/status.png)
diff --git a/docs/commands/stop.md 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)
diff --git a/docs/commands/submit.md 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)
diff --git a/docs/commands/vpn.md b/docs/commands/vpn.md
@@ -0,0 +1,2 @@
+# VPN
+
diff --git 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