Update documentation to v1.6.0

GoToolSharing · Jan 27, 2024 · 4187435 · 4187435
1 parent 59fb7df
commit 4187435
Show file tree

Hide file tree

Showing 22 changed files with 62 additions and 11 deletions.
diff --git a/docs/assets/commands/getflag/demo.png b/docs/assets/commands/getflag/demo.png
diff --git a/docs/assets/commands/hosts/add.png b/docs/assets/commands/hosts/add.png
diff --git a/docs/assets/commands/hosts/delete.png b/docs/assets/commands/hosts/delete.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/stop/stop.png b/docs/assets/commands/stop/stop.png
diff --git a/docs/assets/commands/submit/achievement.png b/docs/assets/commands/submit/achievement.png
diff --git a/docs/assets/commands/submit/achievement2.png b/docs/assets/commands/submit/achievement2.png
diff --git a/docs/assets/commands/submit/challenge.png b/docs/assets/commands/submit/challenge.png
diff --git a/docs/assets/commands/submit/endgame.png b/docs/assets/commands/submit/endgame.png
diff --git a/docs/assets/commands/submit/fortress.png b/docs/assets/commands/submit/fortress.png
diff --git a/docs/assets/commands/submit/machine.png b/docs/assets/commands/submit/machine.png
diff --git a/docs/assets/commands/submit/prolab.png b/docs/assets/commands/submit/prolab.png
diff --git a/docs/assets/commands/submit/ra.png b/docs/assets/commands/submit/ra.png
diff --git a/docs/assets/commands/update/update.png b/docs/assets/commands/update/update.png
diff --git a/docs/assets/commands/version/version.png b/docs/assets/commands/version/version.png
diff --git a/docs/commands/getflag.md b/docs/commands/getflag.md
@@ -0,0 +1,17 @@
+# Getflag
+
+The **getflag** command will make an **SSH connection** to a remote server and try to locate the **user.txt** file in the **home directories**. If the file is found, the flag is submitted directly via the HackTheBox API.
+
+The `-u` / `--username` option is used to specify the **username**.
+
+The `-p` / `--password` option specifies the **password**.
+
+The `--host` option specifies the **hostname**.
+
+The `-P` / `--port` option specifies the **SSH port** (Default: 22).
+
+```bash
+htb-cli getflag -u jaeger -p 'Sh0ppyBest@pp!' --host 10.10.11.180 -P 22 --batch
+```
+
+![Getflag](/assets/commands/getflag/demo.png)
diff --git a/docs/commands/hosts.md b/docs/commands/hosts.md
@@ -0,0 +1,25 @@
+# Hosts
+
+!!! warning "Command in beta (v1)"
+
+    The **hosts** command is a first version and may have **bugs** that could affect your `/etc/hosts` file. If it contains important information, I advise you to save it to avoid unpleasant surprises.
+
+The **hosts** command lets the user interact with the `/etc/hosts` file to **add and remove** entries.
+
+The `-a` / `--add` option specifies the domain to add.
+
+The `-d` / `--delete` option specifies the domain to delete.
+
+The `-i` / `--ip` option specifies the IP address associated with the domain.
+
+```bash
+htb-cli hosts -a git.machine.htb -i 10.10.10.10
+```
+
+![Add](/assets/commands/hosts/add.png)
+
+```bash
+htb-cli hosts -d dev.machine.htb -i 10.10.10.10
+```
+
+![Add](/assets/commands/hosts/delete.png)
diff --git a/docs/commands/start.md b/docs/commands/start.md
@@ -2,7 +2,7 @@
 
 ## 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.
+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 as well as the **start-up time**.
 
 ```bash
 htb-cli start -m Visual

diff --git a/docs/commands/submit.md b/docs/commands/submit.md
@@ -9,14 +9,24 @@ The **submit** command is used to **submit a flag**. Currently, the following su
 * Challenges
 * Fortresses
 
+## Achievements
+
+When submitting a flag with the **submit command**, if the user has submitted both the user flag and the root flag, a link to the user's achievement will be displayed.
+
+```bash
+htb-cli submit -m Shoppy
+```
+
+![Achievement](/assets/commands/submit/achievement.png)
+
+![Achievement2](/assets/commands/submit/achievement2.png)
+
 ## Release Arena
 
 If no flag is submitted, then the machine in **release arena** will be chosen. The machine in **release arena** can also be searched via the `-m` or `--machine` flag.
 
-The `-d` or `--difficulty` flag must be used to indicate the **difficulty** of obtaining the flag.
-
 ```bash
-htb-cli submit -d 3
+htb-cli submit
 ```
 
 ![Machine](/assets/commands/submit/ra.png)
@@ -25,10 +35,8 @@ htb-cli submit -d 3
 
 A **machine name** can be specified to submit the flag for a specific machine. The `-m` or `--machine` option can be used for this.
 
-The `-d` or `--difficulty` flag must be used to indicate the **difficulty** of obtaining the flag.
-
 ```bash
-htb-cli submit -m Sau -d 3
+htb-cli submit -m Sau
 ```
 
 ![Machine](/assets/commands/submit/machine.png)
@@ -76,5 +84,4 @@ The exact name is not essential. A **fuzzy finder** will retrieve the prolab wit
 htb-cli submit --prolab Dante
 ```
 
-![Prolab](/assets/commands/submit/prolab.png)
-
+![Prolab](/assets/commands/submit/prolab.png)
diff --git a/docs/index.md b/docs/index.md
@@ -22,9 +22,9 @@
     <img src="/assets/logo.png" style='width:50%;height:50%'>
 </div>
 
-!!! note "Outdated documentation"
+!!! note "Updated documentation !"
 
-    Documentation is being written for update v1.6.0. Thank you for understanding.
+    The documentation is up to date with the latest release on Github (v1.6.0).
 
 <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.
 It responds to the need to be **competitive**, limit user interaction with the website and **save time** with possible actions.

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -67,6 +67,8 @@ nav:
       - Reset: commands/reset.md
       - Submit: commands/submit.md
       - VPN: commands/vpn.md
+      - Getflag: commands/getflag.md
+      - Hosts: commands/hosts.md
       - Status: commands/status.md