Skip to content

Commit 4187435

Browse files
committed
Update documentation to v1.6.0
1 parent 59fb7df commit 4187435

22 files changed

+62
-11
lines changed

docs/assets/commands/getflag/demo.png

24.6 KB
Loading

docs/assets/commands/hosts/add.png

70 KB
Loading

docs/assets/commands/hosts/delete.png

55.9 KB
Loading

docs/assets/commands/start/search.png

-14.9 KB
Loading
-21.6 KB
Loading

docs/assets/commands/stop/stop.png

-21.3 KB
Loading
22.1 KB
Loading
228 KB
Loading
-28.9 KB
Loading
-59.4 KB
Loading
-15.9 KB
Loading
-17 KB
Loading
-15.9 KB
Loading

docs/assets/commands/submit/ra.png

-16.4 KB
Loading
-27.9 KB
Loading
-28.2 KB
Loading

docs/commands/getflag.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Getflag
2+
3+
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.
4+
5+
The `-u` / `--username` option is used to specify the **username**.
6+
7+
The `-p` / `--password` option specifies the **password**.
8+
9+
The `--host` option specifies the **hostname**.
10+
11+
The `-P` / `--port` option specifies the **SSH port** (Default: 22).
12+
13+
```bash
14+
htb-cli getflag -u jaeger -p 'Sh0ppyBest@pp!' --host 10.10.11.180 -P 22 --batch
15+
```
16+
17+
![Getflag](/assets/commands/getflag/demo.png)

docs/commands/hosts.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Hosts
2+
3+
!!! warning "Command in beta (v1)"
4+
5+
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.
6+
7+
The **hosts** command lets the user interact with the `/etc/hosts` file to **add and remove** entries.
8+
9+
The `-a` / `--add` option specifies the domain to add.
10+
11+
The `-d` / `--delete` option specifies the domain to delete.
12+
13+
The `-i` / `--ip` option specifies the IP address associated with the domain.
14+
15+
```bash
16+
htb-cli hosts -a git.machine.htb -i 10.10.10.10
17+
```
18+
19+
![Add](/assets/commands/hosts/add.png)
20+
21+
```bash
22+
htb-cli hosts -d dev.machine.htb -i 10.10.10.10
23+
```
24+
25+
![Add](/assets/commands/hosts/delete.png)

docs/commands/start.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Machine search
44

5-
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.
5+
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**.
66

77
```bash
88
htb-cli start -m Visual

docs/commands/submit.md

+15-8
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,24 @@ The **submit** command is used to **submit a flag**. Currently, the following su
99
* Challenges
1010
* Fortresses
1111

12+
## Achievements
13+
14+
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.
15+
16+
```bash
17+
htb-cli submit -m Shoppy
18+
```
19+
20+
![Achievement](/assets/commands/submit/achievement.png)
21+
22+
![Achievement2](/assets/commands/submit/achievement2.png)
23+
1224
## Release Arena
1325

1426
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.
1527

16-
The `-d` or `--difficulty` flag must be used to indicate the **difficulty** of obtaining the flag.
17-
1828
```bash
19-
htb-cli submit -d 3
29+
htb-cli submit
2030
```
2131

2232
![Machine](/assets/commands/submit/ra.png)
@@ -25,10 +35,8 @@ htb-cli submit -d 3
2535

2636
A **machine name** can be specified to submit the flag for a specific machine. The `-m` or `--machine` option can be used for this.
2737

28-
The `-d` or `--difficulty` flag must be used to indicate the **difficulty** of obtaining the flag.
29-
3038
```bash
31-
htb-cli submit -m Sau -d 3
39+
htb-cli submit -m Sau
3240
```
3341

3442
![Machine](/assets/commands/submit/machine.png)
@@ -76,5 +84,4 @@ The exact name is not essential. A **fuzzy finder** will retrieve the prolab wit
7684
htb-cli submit --prolab Dante
7785
```
7886

79-
![Prolab](/assets/commands/submit/prolab.png)
80-
87+
![Prolab](/assets/commands/submit/prolab.png)

docs/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@
2222
<img src="/assets/logo.png" style='width:50%;height:50%'>
2323
</div>
2424

25-
!!! note "Outdated documentation"
25+
!!! note "Updated documentation !"
2626

27-
Documentation is being written for update v1.6.0. Thank you for understanding.
27+
The documentation is up to date with the latest release on Github (v1.6.0).
2828

2929
<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.
3030
It responds to the need to be **competitive**, limit user interaction with the website and **save time** with possible actions.

mkdocs.yml

+2
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,8 @@ nav:
6767
- Reset: commands/reset.md
6868
- Submit: commands/submit.md
6969
- VPN: commands/vpn.md
70+
- Getflag: commands/getflag.md
71+
- Hosts: commands/hosts.md
7072
- Status: commands/status.md
7173

7274

0 commit comments

Comments
 (0)