Skip to content

Commit fc405ec

Browse files
committed
Improve documentation
1 parent dfda3fb commit fc405ec

File tree

6 files changed

+25
-10
lines changed

6 files changed

+25
-10
lines changed

.github/workflows/deploy.yml

-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ on:
33
push:
44
branches:
55
- main
6-
- dev
76
permissions:
87
contents: write
98
jobs:
-27.4 KB
Binary file not shown.
27.5 KB
Loading

docs/assets/commands/submit/ra.png

28 KB
Loading

docs/commands/introduction.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ htb-cli info -c OOPArtDB --batch
1212

1313
![Batch](/assets/commands/globals/batch.png)
1414

15-
<!-- ## No Check (--no-check)
15+
## No Check (--no-check)
1616

1717
By default, with each command, a request is sent to **Github** to check if the tool is **up to date** or if a **new version is available**.
1818

19-
The `--no-check` flag allows you not to check if a new update is available. -->
19+
The `--no-check` flag allows you not to check if a new update is available.
2020

2121
## Proxy (--proxy)
2222

docs/commands/submit.md

+23-7
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,26 @@ The **submit** command is used to **submit a flag**. Currently, the following su
77
* Free machines
88
* Release Arena machines
99
* Challenges
10+
* Fortresses
1011

11-
The `-d` or `--difficulty` flag must be used to indicate the **difficulty** of obtaining the flag.
12+
## Release Arena
1213

13-
## Active machine
14+
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.
1415

15-
If there is no `--machine` or `--challenge` flag, submission will be made on the **current active machine**.
16+
The `-d` or `--difficulty` flag must be used to indicate the **difficulty** of obtaining the flag.
1617

1718
```bash
1819
htb-cli submit -d 3
1920
```
2021

21-
![Active](/assets/commands/submit/active.png)
22+
![Machine](/assets/commands/submit/ra.png)
2223

23-
## Find a machine
24+
## Machine
2425

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

28+
The `-d` or `--difficulty` flag must be used to indicate the **difficulty** of obtaining the flag.
29+
2730
```bash
2831
htb-cli submit -m Sau -d 3
2932
```
@@ -32,10 +35,23 @@ htb-cli submit -m Sau -d 3
3235

3336
## Challenge
3437

35-
To **submit a challenge** flag, you can specify its name with the `-c` flag.
38+
To **submit a challenge** flag, you can specify its name with the `-c` or `--challenge` flag.
39+
40+
The `-d` or `--difficulty` flag must be used to indicate the **difficulty** of obtaining the flag.
3641

3742
```bash
3843
htb-cli submit -c OOPArtDB -d 10
3944
```
4045

41-
![Challenge](/assets/commands/submit/challenge.png)
46+
![Challenge](/assets/commands/submit/challenge.png)
47+
48+
## Fortress
49+
50+
To **submit a fortress** flag, you can specify its name with the `-f` or `--fortress` flag.
51+
The exact name is not essential. A **fuzzy finder** will retrieve the fortress with the name closest to the search.
52+
53+
```bash
54+
htb-cli submit -f text
55+
```
56+
57+
![Fortress](/assets/commands/submit/fortress.png)

0 commit comments

Comments
 (0)